← Referência da API

Faturação & pagamentos

Crie e leia faturas, linhas, pagamentos e faturação eletrônica — automatize cobrança de ponta a ponta.

Fatura

Endpoints

POST	/e-invoices/send	Creates a Invoice resource.
GET	/invoices	Retrieves the collection of Invoice resources.
POST	/invoices	Creates a Invoice resource.
GET	/invoices/{id}	Retrieves a Invoice resource.
PATCH	/invoices/{id}	Updates the Invoice resource.
DELETE	/invoices/{id}	Removes the Invoice resource.
GET	/invoices/{id}/send	Retrieves a Invoice resource.
POST	/invoices/{id}/send	Creates a Invoice resource.
GET	/invoices/draft	Retrieves the collection of Invoice resources.
GET	/invoices/name/{date}	Retrieves the collection of Invoice resources.
POST	/invoices/send	Creates a Invoice resource.

Linha da Fatura

Endpoints

GET	/invoice-rows	Retrieves the collection of InvoiceRow resources.
POST	/invoice-rows	Creates a InvoiceRow resource.
GET	/invoice-rows/{id}	Retrieves a InvoiceRow resource.
PATCH	/invoice-rows/{id}	Updates the InvoiceRow resource.

Campos de schema

Campo	Tipo	Descrição
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	string
productName*	string
project	string,null (iri-reference)
parentInvoiceRow	mixed
invoiceChildrenRows	array

Transação da Fatura

Endpoints

GET	/invoice-transactions	Retrieves the collection of InvoiceTransaction resources.
POST	/invoice-transactions	Creates a InvoiceTransaction resource.
GET	/invoice-transactions/{id}	Retrieves a InvoiceTransaction resource.
PATCH	/invoice-transactions/{id}	Updates the InvoiceTransaction resource.
DELETE	/invoice-transactions/{id}	Removes the InvoiceTransaction resource.

Campos de schema

Campo	Tipo	Descrição
id	integer
invoice*	string (iri-reference)
transaction	string,null (iri-reference)
amount	numbernull
date*	string (date-time)
createdAt	string (date-time)
updatedAt	string (date-time)

Método de Pagamento

Endpoints

GET	/payment-methods	Retrieves the collection of PaymentMethod resources.
GET	/payment-methods/{id}	Retrieves a PaymentMethod resource.
PATCH	/payment-methods/{id}	Updates the PaymentMethod resource.
DELETE	/payment-methods/{id}	Removes the PaymentMethod resource.
POST	/payment-methods/create-setup-intent	Creates a PaymentMethod resource.

Campos de schema

Campo	Tipo	Descrição
id	string
organization	string,null (iri-reference)
type	string
ccBrand	string
ccLastDigits	string
ccExpMonth*	integer
ccExpYear*	integer
externalId	string
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
deleted	boolean	Check if the entity has been soft deleted.