Accounting Documents
Attachments
Authorization
Card Customers
Card Transactions
Credit Notes
Custom Properties
Customer Credits
- GETList customer credits
- POSTCreate customer credit
- POSTCreate customer credit line
- DELDelete customer credit line
- PATCHUpdate customer credit line
- GETGet customer credit
- PATCHUpdate customer credit
- POSTPost v1customer credits invoice receivables
- DELDelete v1customer credits invoice receivables
- POSTPost v1customer credits post
Customers
Entities
Expenses
Invoice Approvals
Invoice Payables
- GETList invoice payables
- POSTApprove invoice payable
- POSTCancel invoice payable
- POSTCreate invoice payable
- POSTGenerate document upload URL
- POSTCreate invoice payable line item
- POSTDecline invoice payable
- GETGet invoice payable line item
- PUTUpdate invoice payable line item
- DELDelete invoice payable line item
- GETGet invoice payable
- GETGet invoice document
- GETGet linked credit notes
- POSTSubmit for approval
Invoice Receivables
Journal Entries
Ledger Transactions
Ledger accounts
Products
Purchase Orders
- PUTBatch update purchase order lines
- POSTBulk create purchase order lines
- POSTCancel purchase order
- POSTClose purchase order
- GETList purchase orders
- POSTCreate purchase order
- POSTCreate purchase order line
- GETGet purchase order
- PATCHUpdate purchase order
- POSTLock purchase order
- DELDelete purchase order line
- PATCHUpdate purchase order line
- POSTReset purchase order
Users
Post v1customer credits invoice receivables
Links a customer credit to a sales invoice
curl --request POST \
--url https://api.light.inc/v1/customer-credits/{customerCreditId}/invoice-receivables/{invoiceReceivableId} \
--header 'Authorization: <api-key>'{
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerCredit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentNumber": "<string>",
"documentDate": "2023-12-25",
"status": "DRAFT",
"amount": 123,
"currency": "USD"
},
"invoiceReceivable": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentNumber": "<string>",
"documentDate": "2023-12-25",
"status": "DRAFT",
"amount": 123,
"currency": "USD"
},
"linkedAt": "2023-11-07T05:31:56Z"
}Authorizations
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Response
default response
ID of the company
Invoice payable details
Show child attributes
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
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"
Timestamp when the customer credit was linked to the sales invoice
curl --request POST \
--url https://api.light.inc/v1/customer-credits/{customerCreditId}/invoice-receivables/{invoiceReceivableId} \
--header 'Authorization: <api-key>'{
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerCredit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentNumber": "<string>",
"documentDate": "2023-12-25",
"status": "DRAFT",
"amount": 123,
"currency": "USD"
},
"invoiceReceivable": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentNumber": "<string>",
"documentDate": "2023-12-25",
"status": "DRAFT",
"amount": 123,
"currency": "USD"
},
"linkedAt": "2023-11-07T05:31:56Z"
}