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

credit-notes

{creditNoteId}

invoice-payables

{invoicePayableId}

Link credit note to invoice payable

curl --request POST \
  --url https://api.light.inc/v1/credit-notes/{creditNoteId}/invoice-payables/{invoicePayableId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '{
  "amount": 123
}'

{
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creditNote": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documentNumber": "<string>",
    "documentDate": "2023-12-25",
    "status": "DRAFT",
    "amount": 123,
    "currency": "USD"
  },
  "invoicePayable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documentNumber": "<string>",
    "documentDate": "2023-12-25",
    "status": "DRAFT",
    "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

invoicePayableId

string<uuid>

required

Body

application/json;charset=UTF-8

amount

integer<int64>

Amount to clear in cents

Response

default - application/json;charset=UTF-8

default response

companyId

string<uuid>

ID of the company

creditNote

object

Invoice payable details

Show child attributes

creditNote.id

string<uuid>

Unique identifier for the object

creditNote.documentNumber

string | null

Document number

creditNote.documentDate

string<date> | null

Date the accounting document was issued

creditNote.status

enum<string>

Status of the accounting document

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

DRAFT,

POSTED,

PARTIALLY_CLEARED,

CLEARED,

ARCHIVED

creditNote.amount

integer<int64> | null

The amount of the accounting document in cents

creditNote.currency

string

Example:

"USD"

invoicePayable

object

Invoice payable details

Show child attributes

invoicePayable.id

string<uuid>

Unique identifier for the object

invoicePayable.documentNumber

string | null

Document number

invoicePayable.documentDate

string<date> | null

Date the accounting document was issued

invoicePayable.status

enum<string>

Status of the accounting document

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

DRAFT,

POSTED,

PARTIALLY_CLEARED,

CLEARED,

ARCHIVED

invoicePayable.amount

integer<int64> | null

The amount of the accounting document in cents

invoicePayable.currency

string

Example:

"USD"

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

Unlink credit note from invoice payableRemoves the link between a credit note and an invoice payable

⌘I

Link credit note to invoice payable

curl --request POST \
  --url https://api.light.inc/v1/credit-notes/{creditNoteId}/invoice-payables/{invoicePayableId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '{
  "amount": 123
}'

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

Accounting Documents

Attachments

Authorization

Card Customers

Card Transactions

Cards

Companies

Credit Notes

Custom Properties

Customer Credits

Customers

Entities

Exchange

Expenses

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

Ledger Transactions

Ledger accounts

Products

Purchase Orders

Users

Vendors

Link credit note to invoice payable

Authorizations

Path Parameters

Body

Response