Invoice events

The following Invoice Events are available to Subscribe to in the Events API. Fore more information about how to subscribe to Events, see the main page for events: Events API and Subscribing to Events

INVOICE_CREATED - A new invoice is created

JSON
    
 
InvoiceCreatedPayload{orderId*  integer($int64)orderStatus*  stringorderReferenceId* stringinvoiceNumber*  integer($int64)invoiceType*  string}
Copy

INVOICE_PAYMENT_RECEIVED - A payment has been added to an Invoice

JSON
    
 
WriteOffPaymentPayload{writeOffAmount* integer($int64)invoiceNumber*  string}
Copy

*WRITE_OFF_PAYMENT_CREATED - A write-off payment has been added to an Invoice *

JSON
    
 
WriteOffPaymentPayload{writeOffAmount* integer($int64)invoiceNumber*  string}
Copy

CREDIT_USED - A credit usage has been registered for a credit Invoice

JSON
    
 
CreditUsedPayload{    creditInvoiceNumber* integer($int64)    amountInCents* integer($int64)    currencyCode* string    creditUsedType* string    Enum:    [ MANUAL, PAID_OUT, USED_AS_PAYMENT ]    reference* string}
Copy

We would love to get request for new Events, create a ticket in our support portal and we will look into it!

Last updated on

Was this page helpful?