Skip to main content
POST
Link customer credit to invoice

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

customerCreditId
string<uuid>
required
invoiceReceivableId
string<uuid>
required

Body

application/json;charset=UTF-8
amount
integer<int64> | null

Amount of the customer credit to apply to the sales invoice, in the smallest currency unit. If omitted, the remaining unallocated customer-credit balance is applied, capped by the invoice receivable's remaining balance. Partial allocation is not supported for entities configured with an e-invoicing provider.

Response

default - application/json;charset=UTF-8

default response

companyId
string<uuid>

ID of the company

customerCredit
object

Invoice payable details

invoiceReceivable
object

Invoice payable details

amount
integer<int64>

Amount of the customer credit applied to the sales invoice, in the smallest currency unit

linkedAt
string<date-time>

Timestamp when the customer credit was linked to the sales invoice