LIlight
v1 - Credit Notes

Link credit note to invoice payable

Links a credit note to an invoice payable for clearing (offsetting balances). Because credit notes cannot be applied in the ledger until the invoice payable is posted, this creates a 'link' record that will be used during posting to automatically clear the credit note balance against the invoice payable balance. Requirements: credit note must be in POSTED status, both documents must belong to the same company entity, same vendor (businessPartnerId), same currency, and clearing amount cannot exceed available balance on either document.

post/v1/credit-notes/{creditNoteId}/invoice-payables/{invoicePayableId}

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

creditNoteIdstring uuid required
invoicePayableIdstring uuid required

Request body

amountinteger

Amount to clear in cents

Response

default response

companyIdstring uuid

ID of the company

amountinteger

Clearing amount in cents

currencystring
createdAtstring date-time

Timestamp when the link was created

updatedAtstring date-time

Timestamp when the link was last updated

Example response

{
  "creditNote": {
    "currency": "USD"
  },
  "invoicePayable": {
    "currency": "USD"
  },
  "currency": "USD"
}

Changes

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