Webhooks

Webhook triggered on installment status updates

post
/webhooks/invoice_installments_status_anticipation

The platform supports webhook notifications to inform clients of changes in the status of submitted invoice installments.

This webhook is triggered whenever a installment status is updated in the anticipation process.

To use this feature, you must implement an HTTPS POST endpoint on your system to receive event notifications. Once a webhook is triggered, our platform will send a POST request to the configured URL with the relevant payload.

Anticipation status:

  • Created: Invoice installment submitted

  • Updated: Invoice installment updated

  • Deleted: Invoice installment deleted

  • Requested: Anticipation requested

  • Approved: Anticipation approved

  • Rejected: Anticipation rejected

  • Cancelled: Anticipation cancelled

  • Settled: Anticipation settled

  • Failed: Invoice installment update failed

Body
issue_datestring · dateRequired
invoice_numberstringRequired
invoice_seriesstringRequired
installmentstringRequired
installment_due_datestring · dateRequired
installment_amountnumber · floatRequired
document_supplierstringRequired
anticipation_statusstring · enumOptionalPossible values:
idstring · uuidOptional
factoring_payable_idstring · uuidOptional
Responses
200

Acknowledged

No content

post
/webhooks/invoice_installments_status_anticipation
200

Acknowledged

No content

Webhook triggered on factoring payables status updates

post
/webhooks/factoring_payables_status

The platform supports webhook notifications to inform clients of changes in the status of submitted factoring payables (Assignment of Receivables).

This webhook is triggered whenever a installment status is updated in the anticipation process.

To use this feature, you must implement an HTTPS POST endpoint on your system to receive event notifications. Once a webhook is triggered, our platform will send a POST request to the configured URL with the relevant payload.

Anticipation status:

  • Created: Factoring payables submitted

  • Updated: Factoring payables updated

  • Deleted: Factoring payables deleted

  • Settled: Factoring payables settled

Body
document_numberstringRequired
installmentstringRequired
installment_due_datestring · dateRequired
installment_amountnumber · floatRequired
document_supplierstringRequired
anticipation_statusstring · enumOptionalPossible values:
hash_brcodestringOptional
idstring · uuidOptional
invoice_installment_idstring · uuidOptional
Responses
200

Acknowledged

No content

post
/webhooks/factoring_payables_status
200

Acknowledged

No content

Last updated

Was this helpful?