Get an invoice based on the invoiceId
get
https://api.mercadoe.com/v1/invoices/{invoiceId}
Retrieve information about a specific invoice with the given invoiceId.
Request
Path Parameters
invoiceId
int32
required
the invoice id
Responses
200
404
500
OK
Body
application/json
invoiceId
int32
A unique identifier or alias for the invoice identifier.
tenantId
int32
A unique identifier or alias for the requesting tenant.
supplierId
int32
A unique identifier or alias for the Supplier.
serialNumber
string | null
Invoice Serial Number
issueDate
date-time | null
Invoice issue date
totalDue
double | null
Total amount due informed on the invoice (calculated by the total price of the items)
currency
string | null
Currency in alphabetic code (for more information, please refer to: https://www.iso.org/iso-4217-currency-codes.html).
creationDate
date-time | null
Invoice creation date
updateDate
date-time | null
Invoice update date
isIntegrated
boolean
Indicates if the invoice is integrated
integrationDate
date-time | null
It provides the integration date
netPrice
double | null
Invoice net price
orderId
int32
deprecated
ID of the ME purchase order
clientOrderId
string | null
deprecated
The order ID in the Client’s ERP
invoiceNumber
string | null
Invoice number
invoiceSerial
string | null
Invoice serial number
dateTime
date-time | null
Invoice issue date and time
freightValue
double | null
Freight value informed on the invoice
invoiceCharging
double | null
Amount of invoice charges
invoiceDiscounts
double | null
Amount of invoice discounts
userId
int32 | null
ID of the user who created the invoice
userLogin
string | null
Login of the user who created the invoice
deliveryPlace
string | null
deprecated
Delivery Place
paymentCondition
string | null
deprecated
Payment condition (provided in the order)
itemQuantity
int32 | null
deprecated
Quantity of invoice items
clientSupplierId
string | null
Supplier identifier in the ERP
requester
string | null
deprecated
Requester of the invoice
requesterPhoneNumber
string | null
deprecated
Requester phone number
grossServiceAmount
double | null
deprecated
Gross value of provided services
invoiceCode
string | null
deprecated
Invoice code
exchangeRate
double | null
Value of the foreign currency exchange rate.
withholding
double | null
Withholding tax amount
orders
array of object
List of orders related to the invoice, consisting of the fields
OrderId, ClientOrderId, ClientSupplierId, among others.