Home

February 12, 2025

Get Invoice Payments

The Invoice API can now be queried to return all of the payments and credit applied to an invoice by using $expand=Payments. This can also be used in conjunction with the invoice presentation line items expand to retrieve both: GET /v3/Invoices/{InvoiceKey}$expand=LineItems,Payments

Please note that this expand only works for individual invoice requests and not the invoice lists request.

The array of payments returned is the same as the list seen on the Invoice Payments tab. Each payment returns basic details including PaymentType, where:

  • Payment means a Karbon Payment
  • Payment Reversed means a Karbon Payment has been reversed or refunded
  • Manual Payment means a Manual Payment that has been created in Karbon or via the API
  • Manual Payment Reversed means a Manual Payment has been reversed
  • Credit Note means credit from the corresponding Credit Note has been applied

Get Payments

A new Payments API can now be queried to return a list of payments: GET /v3/Payments/

This is the same as the payments seen on the Payment Report under Billing / Finance / Payments. Each payment include basic details including PaymentType, where:

  • Payment means a Karbon Payment
  • Payment Reversed means a Karbon Payment has been reversed or refunded
  • Payment Processing means a Karbon Payment is processing and has not yet succeeded
  • Payment Failed means a Karbon Payment failed and will be reversed
  • Manual Payment means a Manual Payment
  • Manual Payment Reversed means a Manual Payment has been reversed

Where PaymentType is Karbon Payment, additional details are returned in a KarbonPayment object, otherwise the value of KarbonPayment will be null.

Delete Manual Payment

If a Manual Payment has been recorded and needs to be deleted you can now request this by calling DELETE /v3/ManualPayments/{ManualPaymentsKey}. This will return a 204 on successful deletion.

Invoice list optimisation

The Invoices API performance has been improved in cases where large numbers of invoices will be returned GET /v3/Invoices

Please note that as a result we have removed the ability to use $expand=LineItems from the list request. To obtain the presentation line items and newly added payments you can request those for an individual invoice, e.g.: GET /v3/Invoices/{InvoiceKey}$expand=LineItems,Payments