Bemmbo Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

Event Types

collections_reminder_by_account

collections_reminder_by_invoice

customer_debt_status_changed

invoice_deconciled_from_payments

invoice_reconciled_to_payments

customer

object

5 Items

event

object

1 Items

invoices

array[]

totalAmount

number

Example

JSON

{
  "customer": {
    "fiscalId": "86345678-9",
    "logoURL": "https://example.com/logos/company_logo.png",
    "name": "Evil Corp",
    "portalURL": "https://app.bemmbo.com/evil",
    "verificationCode": "ABC123XYZ"
  },
  "event": {
    "type": "issued"
  },
  "invoices": [
    {
      "amountToBePaid": 2000000,
      "conciliatedAmount": 5000000,
      "dueBy": "2024-10-15T00:00:00Z",
      "number": "inv_6OkjqPtOKD5MAp9V",
      "receiverFiscalId": "98765432-1",
      "status": "PARTIALLY_PAID"
    },
    {
      "amountToBePaid": 2000000,
      "conciliatedAmount": 0,
      "dueBy": "2024-10-15T00:00:00Z",
      "number": "inv_lJrj6wt05yWrZmO7",
      "receiverFiscalId": "80765432-k",
      "status": "PENDING"
    }
  ],
  "totalAmount": 4000000
}

customer

object

5 Items

event

object

1 Items

invoice

object

5 Items

Example

JSON

{
  "customer": {
    "fiscalId": "86345678-9",
    "logoURL": "https://example.com/logos/company_logo.png",
    "name": "Evil Corp",
    "portalURL": "https://app.bemmbo.com/evil",
    "verificationCode": "ABC123XYZ"
  },
  "event": {
    "type": "about_to_expire"
  },
  "invoice": {
    "amountToBePaid": 2500000,
    "dueBy": "2024-10-15",
    "number": "435322",
    "referenceNumber": "inv_ZNfJ4UtQ86wPaX7Y",
    "totalAmount": 5000000
  }
}

customerId

string

debt

number

status

string

updatedAt

string

Example

JSON

{
  "customerId": "4fd4a4a3-fa1f-436f-bfab-930f216d6c54",
  "debt": 30000000,
  "status": "WITH_DEBT",
  "updatedAt": "2024-10-15T00:00:00Z"
}

deconciledAt

string

invoiceId

string

movements

array[]

Example

JSON

{
  "deconciledAt": "2024-10-15T00:00:00Z",
  "invoiceId": "inv_ZNfJ4UtQ86wPaX7Y",
  "movements": [
    {
      "assignedAmount": 100000,
      "movementId": "mov_kNeeRttQ86wPaX7Y"
    }
  ]
}

invoiceId

string

movements

array[]

reconciledAt

string

Example

JSON

{
  "invoiceId": "inv_x9a8j89G7Fj",
  "movements": [
    {
      "assignedAmount": 1500000,
      "movementId": "mov_3kOj89F5kGj89"
    }
  ],
  "reconciledAt": "2024-10-01T12:00:00Z"
}