Sales Invoices

The sales invoices resource.

Basehttps://rest.carbon.ms/salesInvoices

GET/salesInvoices

List sales invoicess

Retrieve a paginated list of sales invoicess. 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/salesInvoices

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

Response

[
  {
    "id": "abc123def456",
    "invoiceId": "xyz789",
    "status": "string",
    "customerId": "xyz789",
    "customerReference": "string",
    "invoiceCustomerId": "xyz789",
    "invoiceCustomerLocationId": "xyz789",
    "invoiceCustomerContactId": "xyz789"
  }
]

GET/salesInvoices

Retrieve a sales invoices

Fetch a single sales invoices by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesInvoices

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

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "customerReference": "string",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789"
}