Sales Invoice

The sales invoice resource.

Basehttps://rest.carbon.ms/salesInvoice

GET/salesInvoice

List sales invoices

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

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

Response

[
  {
    "id": "abc123def456",
    "invoiceId": "xyz789",
    "status": "string",
    "customerId": "xyz789",
    "currencyCode": "string",
    "subtotal": 0,
    "totalDiscount": 10,
    "totalAmount": 0
  }
]

GET/salesInvoice

Retrieve a sales invoice

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesInvoice

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

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "currencyCode": "string",
  "subtotal": 0,
  "totalDiscount": 10,
  "totalAmount": 0
}

POST/salesInvoice

Create a sales invoice

Create a new sales invoice.

Body parameters

invoiceIdstringrequired

statussalesInvoiceStatusrequired

customerIdstringrequired

References customer.id

customerReferencestring

invoiceCustomerIdstring

References customer.id

invoiceCustomerLocationIdstring

References customerLocation.id

invoiceCustomerContactIdstring

References customerContact.id

paymentTermIdstring

References paymentTerm.id

postingDatedate

dateIssueddate

dateDuedate

datePaiddate

locationIdstring

References location.id

currencyCodestringrequired

References currencyCode.code

subtotalnumberrequired

totalDiscountnumberrequired

totalAmountnumberrequired

totalTaxnumberrequired

balancenumberrequired

exchangeRatenumberrequired

exchangeRateUpdatedAttimestamp

opportunityIdstring

References opportunity.id

shipmentIdstring

References shipment.id

assigneestring

companyIdstringrequired

References company.id

customFieldsobjectrequired

internalNotesobjectrequired

externalNotesobjectrequired

tagsarray

POSThttps://rest.carbon.ms/salesInvoice

curl --request POST \
  --url https://rest.carbon.ms/salesInvoice \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"invoiceId":"xyz789","status":"string","customerId":"xyz789","currencyCode":"string","subtotal":0,"totalDiscount":10,"totalAmount":0,"totalTax":0,"balance":0,"exchangeRate":0,"companyId":"xyz789","customFields":"string","internalNotes":"string","externalNotes":"string"}'

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "currencyCode": "string",
  "subtotal": 0,
  "totalDiscount": 10,
  "totalAmount": 0
}

PATCH/salesInvoice

Update a sales invoice

Update an existing sales invoice, matched on `id`.

Body parameters

invoiceIdstringrequired

statussalesInvoiceStatusrequired

customerIdstringrequired

References customer.id

customerReferencestring

invoiceCustomerIdstring

References customer.id

invoiceCustomerLocationIdstring

References customerLocation.id

invoiceCustomerContactIdstring

References customerContact.id

paymentTermIdstring

References paymentTerm.id

postingDatedate

dateIssueddate

dateDuedate

datePaiddate

locationIdstring

References location.id

currencyCodestringrequired

References currencyCode.code

subtotalnumberrequired

totalDiscountnumberrequired

totalAmountnumberrequired

totalTaxnumberrequired

balancenumberrequired

exchangeRatenumberrequired

exchangeRateUpdatedAttimestamp

opportunityIdstring

References opportunity.id

shipmentIdstring

References shipment.id

assigneestring

companyIdstringrequired

References company.id

customFieldsobjectrequired

internalNotesobjectrequired

externalNotesobjectrequired

tagsarray

PATCHhttps://rest.carbon.ms/salesInvoice

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

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "currencyCode": "string",
  "subtotal": 0,
  "totalDiscount": 10,
  "totalAmount": 0
}

DELETE/salesInvoice

Delete a sales invoice

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/salesInvoice

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

204 No Content