Receipt

The receipt resource.

Basehttps://rest.carbon.ms/receipt

GET/receipt

List receipts

Retrieve a paginated list of receipts. 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/receipt

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

Response

[
  {
    "id": "abc123def456",
    "receiptId": "xyz789",
    "status": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "locationId": "xyz789",
    "sourceDocument": "string"
  }
]

GET/receipt

Retrieve a receipt

Fetch a single receipt by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/receipt

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

Response

{
  "id": "abc123def456",
  "receiptId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "sourceDocument": "string"
}

POST/receipt

Create a receipt

Create a new receipt.

Body parameters

receiptIdstringrequired

locationIdstring

References location.id

sourceDocumentreceiptSourceDocument

sourceDocumentIdstring

sourceDocumentReadableIdstring

externalDocumentIdstring

supplierIdstring

References supplier.id

statusreceiptStatusrequired

postingDatedate

invoicedboolean

assigneestring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

internalNotesobject

supplierInteractionIdstring

References supplierInteraction.id

postedBystring

References user.id

POSThttps://rest.carbon.ms/receipt

curl --request POST \
  --url https://rest.carbon.ms/receipt \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"receiptId":"xyz789","status":"string","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "receiptId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "sourceDocument": "string"
}

PATCH/receipt

Update a receipt

Update an existing receipt, matched on `id`.

Body parameters

receiptIdstringrequired

locationIdstring

References location.id

sourceDocumentreceiptSourceDocument

sourceDocumentIdstring

sourceDocumentReadableIdstring

externalDocumentIdstring

supplierIdstring

References supplier.id

statusreceiptStatusrequired

postingDatedate

invoicedboolean

assigneestring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

internalNotesobject

supplierInteractionIdstring

References supplierInteraction.id

postedBystring

References user.id

PATCHhttps://rest.carbon.ms/receipt

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

Response

{
  "id": "abc123def456",
  "receiptId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "sourceDocument": "string"
}

DELETE/receipt

Delete a receipt

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/receipt

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

204 No Content