Skip to main content
POST
Error

Authorizations

​
x-api-key
string
header
required

unique identifier access key. each brand has it own unique key.

Body

application/json
​
receivableCode
string
required

code of the receivable title

Example:

"TIT-5678"

​
integrationCode
string
required

unique key of the installment within the brand. sending it again returns 409

Example:

"TIT-5678-1"

​
documentType
enum<string>
required

classification of the title, returned and filterable on the listing. it does not change any processing

Available options:
INVOICE,
CREDIT,
DEBIT,
CASH,
CHECK,
PIX
​
installmentNumber
number
required

position of the installment in the title, not checked for uniqueness

Example:

1

​
expirationDate
string<date>
required

due date. only the date is stored, a value carrying time is rejected

Example:

"2026-08-15"

​
value
number
required

amount to be received

Example:

150.5

​
paidValue
number
required

amount already received

Example:

0

​
status
enum<string>
required

PAID requires paymentDate in the same payload

Available options:
PENDING,
PAID,
OVERDUE
​
netValue
number
required

net value of the installment

Example:

150.5

​
grossValue
number
required

gross value of the installment

Example:

160

​
customerCode
string

code of the customer in the brand; provide this OR customerCnpj

Example:

"CUST-001"

​
customerCnpj
string

CPF/CNPJ of the customer; provide this OR customerCode

Example:

"05768567000126"

​
invoiceId
string

internal UUID of the related invoice; provide this OR invoiceAccessKey

Example:

"00011f00-2224-4339-894a-f065d855ec70"

​
invoiceAccessKey
string

access key of the related NF-e (44 digits); provide this OR invoiceId

Example:

"41250605768567000126550030001387591780234910"

​
paymentDate
string<date>

payment date. only the date is stored, a value carrying time is rejected

Example:

"2026-08-10"

​
discount
number

discount value

Example:

9.5

​
chargesValue
number

interest and fine charges

Example:

0

​
bankSlipBarcode
string

bank slip barcode

​
pixQrCode
string

pix qr code

​
digitableLine
string

bank slip digitable line

Response

create accounts receivable installment

​
id
string
required

use it later to attach the bank slip pdf to this installment

​
integrationCode
string
required

unique key of the installment within the brand, as sent in this request

​
receivableCode
string
required

code of the receivable title that groups the installments

​
installmentNumber
number
required

position of the installment in the title, not a unique key

​
status
enum<string>
required

status as sent in this request. only a later ERP import with the same integrationCode can change it

Available options:
PENDING,
PAID,
OVERDUE