Get linked invoice payables - Light API documentation

GET

credit-notes

{creditNoteId}

invoice-payables

Get linked invoice payables

curl --request GET \
  --url https://api.light.inc/v1/credit-notes/{creditNoteId}/invoice-payables \
  --header 'Authorization: <api-key>'

[
  {
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "creditNote": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentNumber": "<string>",
      "documentDate": "2023-12-25",
      "amount": 123,
      "currency": "USD"
    },
    "invoicePayable": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentNumber": "<string>",
      "documentDate": "2023-12-25",
      "amount": 123,
      "currency": "USD"
    },
    "amount": 123,
    "currency": "USD",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization

string

header

required

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

Path Parameters

creditNoteId

string<uuid>

required

Response

default - application/json;charset=UTF-8

default response

companyId

string<uuid>

ID of the company

creditNote

object

Invoice payable details

Show child attributes

invoicePayable

object

Invoice payable details

Show child attributes

amount

integer<int64>

Clearing amount in cents

currency

string

Example:

"USD"

createdAt

string<date-time>

Timestamp when the link was created

updatedAt

string<date-time>

Timestamp when the link was last updated

Link credit note to invoice payableLinks 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.

⌘I

Get linked invoice payables

curl --request GET \
  --url https://api.light.inc/v1/credit-notes/{creditNoteId}/invoice-payables \
  --header 'Authorization: <api-key>'

[
  {
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "creditNote": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentNumber": "<string>",
      "documentDate": "2023-12-25",
      "amount": 123,
      "currency": "USD"
    },
    "invoicePayable": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentNumber": "<string>",
      "documentDate": "2023-12-25",
      "amount": 123,
      "currency": "USD"
    },
    "amount": 123,
    "currency": "USD",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]