Supplier Ledger

The supplier ledger resource.

Basehttps://rest.carbon.ms/supplierLedger

GET/supplierLedger

List supplier ledgers

Retrieve a paginated list of supplier ledgers. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/supplierLedger

curl --request GET \
  --url 'https://rest.carbon.ms/supplierLedger?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "entryNumber": 0,
    "postingDate": "2026-01-01",
    "supplierId": "xyz789",
    "amount": 0,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "documentType": "string"
  }
]

GET/supplierLedger

Retrieve a supplier ledger

Fetch a single supplier ledger by filtering on `id`.

Query parameters

idstring

Match on the supplier ledger's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplierLedger

curl --request GET \
  --url 'https://rest.carbon.ms/supplierLedger?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "entryNumber": 0,
  "postingDate": "2026-01-01",
  "supplierId": "xyz789",
  "amount": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "documentType": "string"
}

POST/supplierLedger

Create a supplier ledger

Create a new supplier ledger.

Body parameters

entryNumbernumberrequired

postingDatedaterequired

documentTypesupplierLedgerDocumentType

documentIdstring

externalDocumentIdstring

supplierIdstringrequired

References supplier.id

amountnumberrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/supplierLedger

curl --request POST \
  --url https://rest.carbon.ms/supplierLedger \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"entryNumber":0,"postingDate":"2026-01-01","supplierId":"xyz789","amount":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "entryNumber": 0,
  "postingDate": "2026-01-01",
  "supplierId": "xyz789",
  "amount": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "documentType": "string"
}

PATCH/supplierLedger

Update a supplier ledger

Update an existing supplier ledger, matched on `id`.

Body parameters

entryNumbernumberrequired

postingDatedaterequired

documentTypesupplierLedgerDocumentType

documentIdstring

externalDocumentIdstring

supplierIdstringrequired

References supplier.id

amountnumberrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/supplierLedger

curl --request PATCH \
  --url 'https://rest.carbon.ms/supplierLedger?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"entryNumber":0}'

Response

{
  "id": "abc123def456",
  "entryNumber": 0,
  "postingDate": "2026-01-01",
  "supplierId": "xyz789",
  "amount": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "documentType": "string"
}

DELETE/supplierLedger

Delete a supplier ledger

Delete a supplier ledger, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the supplier ledger to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/supplierLedger

curl --request DELETE \
  --url 'https://rest.carbon.ms/supplierLedger?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content