Qodex.ai

Create credit notes

POST {{baseInfraUrl}}/{{version}}/credit-note

Create a Credit Note to generate a CCB contract. The Total Effective Cost (CET) of the contract will be automatically calculated based on the installment flow chosen. It may not surpass 1000% per year.

ParametersValue TypeDescription
templateIdREQUIREDId of the contract template which the credit note will be based on
nameREQUIREDDebtor's full name
taxIdREQUIREDDebtor's taxId (CPF/CNPJ)
nominalAmountREQUIREDAmount in cents transferred to the credit receiver, before deductions.
scheduledREQUIREDMinimum date of payment execution. Execution will only happen if the credit note has been signed.
invoicesREQUIREDList of Invoice objects to be created and sent to the credit receiver.
paymentREQUIREDPayment object (for example a Transfer) to be created and sent to the credit receiver.
paymentTypeREQUIREDPayment object type to be sent to the credit receiver.
signersREQUIREDList of dictionaries. Each dictionary contains the signer's name, email and delivery method for the contract.
externalIdREQUIREDString that must be unique among all your Credit Notes.
cityREQUIREDDebtor's city name.
stateCodeREQUIREDDebtor's state code.
districtREQUIREDDebtor's district name.
streetLine1REQUIREDDebtor's street address.
streetLine2REQUIREDDebtor's street address complement.
zipCodeREQUIREDDebtor's zip code.
expirationOPTIONALTime in seconds counted from the scheduled datetime until the Credit Note expires. After expiration, the Credit Note cannot be signed anymore.
rebateAmountOPTIONALCredit analysis fee deducted from the nominal amount.
tagsOPTIONALList of strings for reference when searching for Credit Notes

Request Body

{"notes"=>[{"externalId"=>"my_unique_id_postman1", "invoices"=>[{"amount"=>234413, "due"=>"2023-06-16"}], "name"=>"Jamie Lannister", "nominalAmount"=>200000, "rebateAmount"=>0, "scheduled"=>"2022-06-07", "signers"=>[{"contact"=>"jamie.lannister@gmail.com", "method"=>"link", "name"=>"Jamie Lannister"}], "taxId"=>"012.345.678-90", "templateId"=>"5707012469948416", "paymentType"=>"transfer", "payment"=>{"accountNumber"=>"5005482", "bankCode"=>"60701190", "branchCode"=>"7248", "name"=>"Jamie Lannister", "taxId"=>"594.739.480-42"}, "city"=>"São Paulo", "stateCode"=>"SP", "district"=>"Jardim Paulista", "streetLine1"=>"Rua ABC", "streetLine2"=>"Ap 123", "zipCode"=>"01234-567"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"notes":[{"amount":193240,"city":"São Paulo","created":"2022-06-07T14:06:14.894539+00:00","district":"Jardim Paulista","documentId":"","expiration":"2022-06-14T11:06:14.705451+00:00","externalId":"my_unique_id_postman","id":"6256617557327872","interest":20.68,"invoices":[{"amount":234413,"descriptions":[],"discounts":[],"due":"2023-06-17T02:59:59.999999+00:00","expiration":5097600,"fine":2,"id":"","interest":1,"name":"Jamie Lannister","tags":[],"taxId":"012.345.678-90"}],"name":"Jamie Lannister","nominalAmount":200000,"nominalInterest":16.71,"payment":{"accountNumber":"5005482","accountType":"checking","amount":193240,"bankCode":"60701190","branchCode":"7248","id":"","name":"Jamie Lannister","scheduled":"2022-06-07T14:06:14.714676+00:00","status":"","tags":[],"taxId":"594.739.480-42"},"paymentType":"transfer","rebateAmount":0,"scheduled":"2022-06-07T11:06:14.705451+00:00","signers":[{"contact":"jamie.lannister@gmail.com","method":"link","name":"Jamie Lannister"},{"contact":"39.908.427/0001-28","method":"server","name":"Stark Sociedade de Crédito Direto S.A."}],"stateCode":"SP","status":"created","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxAmount":6760,"taxId":"012.345.678-90","templateId":"5707012469948416","transactionIds":[],"updated":"2022-06-07T14:06:14.894559+00:00","workspaceId":"6275127679385600","zipCode":"01234-567"}]}