Updates the clearing amount of a linked invoice payable
curl --request PATCH \
--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"
}Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Updated amount to clear in cents
default response
ID of the company
Invoice payable details
Show child attributes
Unique identifier for the object
Document number
Date the accounting document was issued
Status of the accounting document
⚠️ This enum is not exhaustive; new values may be added in the future.
DRAFT, POSTED, PARTIALLY_CLEARED, CLEARED, ARCHIVED The amount of the accounting document in cents
"USD"
Invoice payable details
Show child attributes
Unique identifier for the object
Document number
Date the accounting document was issued
Status of the accounting document
⚠️ This enum is not exhaustive; new values may be added in the future.
DRAFT, POSTED, PARTIALLY_CLEARED, CLEARED, ARCHIVED The amount of the accounting document in cents
"USD"
Clearing amount in cents
"USD"
Timestamp when the link was created
Timestamp when the link was last updated
curl --request PATCH \
--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"
}