LIlight
v1 - Customer Credits

Link customer credit to invoice

Links a customer credit to a sales invoice

post/v1/customer-credits/{customerCreditId}/invoice-receivables/{invoiceReceivableId}/link

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

customerCreditIdstring uuid required
invoiceReceivableIdstring uuid required

Request body

amountinteger nullable

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 response

companyIdstring uuid

ID of the company

amountinteger

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

linkedAtstring date-time

Timestamp when the customer credit was linked to the sales invoice

Example response

{
  "customerCredit": {
    "currency": "USD"
  },
  "invoiceReceivable": {
    "currency": "USD"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.