Create an invoice

Create an invoice

Body Params
string

Company id of the supplier in Brinta's system. Create a new company in the company section. If not sent, the supplier will be Brinta's client.

string

Company id of the supplier in the Client's system.

string

The ID of the transaction in the client's system.

string

ID of the invoice being referenced.

string

ID of the invoice being referenced in client's system

boolean
Defaults to false

Boolean to indicate if the invoice will be processed electronically through the tax authority. If not sent, default to TRUE

string

When storing invoice and not issuing a new one. Possible values "inbound", "outbound"

string
enum
required

The type of invoice. It can be "debit", "credit" (for credit notes), "support_document" (for purchasing invoices), "transport" (for transport invoices), "payment" for (Payment Invoices, e.g.: "Complementos de Pago in MX")

Allowed:
date-time

Date of the invoice (UTC by default)

date-time

The invoice due date (UTC by default).

string

The serie of the invoice. Also used for the point of sale.

string

The number of the invoice.

string

When sending INBOUND, OUTBOUND base types. The key number of the invoice on the tax authority's system (CHAVE, CUFE, etc)

string
required

Type of the invoice document. See possibles values in Invoice document types

string

Reason for creating the document. See possibles values in Invoice reasons

string

When the document_type is export, credit note exports, or debit note exports. See values in Invoice reasons

string

For Mexico, used for 'objetoImpuesto'.

float

It appears in RESPONSE. The amount of the invoice excluding taxes.

float

It appears in RESPONSE. The amount of the invoice including taxes.

float

Discount applied to the overall invoice

string

Language of the invoice in ISO 639 code. Whenever local regulations allow it, the invoice will be created with sent language. If not sent, it will use the default language of buyer's country.

string
required

The currency code of the invoice amount. It can be the local currency or international_currency set for the supplier. See possible values in Country Coverage and currencies

float

The exchange rate from the currency to the international currency set for the supplier.

payment_method
object

The payment method used for the transaction.

amounts
array of objects

Document-level payment amounts. Used for Mexico Payment Invoice (Complemento de Pago) Mode A, where the client calculates all totals. Not required for Mode B.

amounts
taxes
array of objects

Document-level taxes. Used for Mexico Payment Invoice (Complemento de Pago) Mode A. Includes both transferred and withheld tax totals. Not required for Mode B.

taxes
date

Payment date of the invoice

date

In Accounting, entry date of the invoice

string

Purchase order Number linked to the invoice

string

Additional information regarding the invoice.

buyer
object
required

Information of the buyer. Only one of company_id, company_external_id, company can be sent.

items
array of objects
required

Array of items of the invoice

items*
senders
array of objects

Information of the senders.

senders
beneficiaries
array of objects

Information of the beneficiaries.

beneficiaries
vehicle
object

Vehicle information for transport documents (bill of lading and Peru transport). Structure varies by transport type.

transportation_companies
array of objects

Information about the transport figures (drivers, owners, and carriers). Used for bill of lading (Carta Porte) and Peru transport documents.

transportation_companies
relations
array of objects

Related documents. Used in two contexts: (1) MX Payment Invoice (Complemento de Pago) — links payment events to the original invoices being settled, with two levels of nesting (relations[].relations[]). (2) Peru transport (Guia de Remision) — references related invoices or transport documents from the same or different supplier.

relations
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json