API Reference

Invoice webhooks

The invoice API provides notifications through webhooks when the invoice request has changed its status.

Possible events sent through webhooks define each status of the invoice request:

  • received
  • in process
  • created
  • failed
  • cancel process
  • canceled
  • pending (For Inbound invoices)
  • approved (For Inbound invoices)
  • rejected (For Inbound invoices)

Each webhook will present the invoice_id, so you can retrieve all the invoice information (and the invoice itself if the status is completed) using the Get an invoice section.

Examples of webhooks

{
  "resource": "invoice",
  "event": "created",
  "data": {
    "invoice_id": "ca791d36-6961-45f7-831d-8f7b5a077c73",
    "invoice_external_id": "A0B1",
    "status": "created"
  }
}

{
  "resource": "invoice",
  "event": "created",
  "data": {
    "invoice_id": "ca791d36-6961-45f7-831d-8f7b5a077c73",
    "invoice_external_id": "A0B1",
    "status": "created",
    "clientApprovalStatus": "pending"
  }
}

{
  "resource": "invoice",
  "event": "approved by client",
  "data": {
    "invoice_id": "ca791d36-6961-45f7-831d-8f7b5a077c73",
    "invoice_external_id": "A0B1",
    "status": "created",
    "clientApprovalStatus": "approved"
  }
}