Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Invoices

Retrieve an invoice

get/sellers/{seller_id}/invoices/{id}

Path parameters

seller_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Response

Successful operation

buyer_idstring required

Identifier for the buyer

currencystring required

ISO 4217 currency code for all monetary amounts on this invoice

countrystring required

ISO 3166-1 alpha-2 country code where the invoice is issued

amount_dueinteger required

Total amount due on the invoice

amount_paidinteger required

Amount already paid on this invoice

amount_remaininginteger required

Amount still remaining to be paid

invoice_datestring date required

Date when the invoice was issued

due_datestring date required

Date when the payment is due

totalinteger required

Total amount of the invoice including all charges, shipping, tax, etc.

supplier_idstring

Identifier for the supplier, if different from seller

invoice_pdfstring uri

URL to the PDF version of the invoice

billing_reasonstring

Reason for billing the buyer

payment_methodstring

Payment method used or to be used for this invoice

chargesinteger

Amount of charges applied to this invoice

discountinteger

Amount of discount applied to this invoice

shippinginteger

Shipping costs included in this invoice

taxinteger

Tax amount applied to this invoice

metadataobject

Additional custom data associated with this invoice

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "buyer_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "currency": "USD",
  "amount_due": 10000,
  "amount_paid": 10000,
  "amount_remaining": 10000,
  "invoice_date": "2024-01-15",
  "due_date": "2024-01-15",
  "total": 10000,
  "supplier_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "invoice_pdf": "https://www.acme.com",
  "charges": 10000,
  "discount": 10000,
  "shipping": 10000,
  "tax": 10000,
  "fiscal_invoice_id": "cfdi:550e8400-e29b-41d4-a716-446655440000",
  "metadata": {
    "key": "value"
  },
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}