Sales Order Payment

The sales order payment resource.

Basehttps://rest.carbon.ms/salesOrderPayment

GET/salesOrderPayment

List sales order payments

Retrieve a paginated list of sales order payments. 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/salesOrderPayment

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

Response

[
  {
    "id": "abc123def456",
    "paymentComplete": true,
    "companyId": "xyz789",
    "invoiceCustomerId": "xyz789",
    "invoiceCustomerLocationId": "xyz789",
    "invoiceCustomerContactId": "xyz789",
    "paymentTermId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/salesOrderPayment

Retrieve a sales order payment

Fetch a single sales order payment by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesOrderPayment

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

Response

{
  "id": "abc123def456",
  "paymentComplete": true,
  "companyId": "xyz789",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/salesOrderPayment

Create a sales order payment

Create a new sales order payment.

Body parameters

invoiceCustomerIdstring

References customer.id

invoiceCustomerLocationIdstring

References customerLocation.id

invoiceCustomerContactIdstring

References customerContact.id

paymentTermIdstring

References paymentTerm.id

paymentCompletebooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/salesOrderPayment

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

Response

{
  "id": "abc123def456",
  "paymentComplete": true,
  "companyId": "xyz789",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/salesOrderPayment

Update a sales order payment

Update an existing sales order payment, matched on `id`.

Body parameters

invoiceCustomerIdstring

References customer.id

invoiceCustomerLocationIdstring

References customerLocation.id

invoiceCustomerContactIdstring

References customerContact.id

paymentTermIdstring

References paymentTerm.id

paymentCompletebooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/salesOrderPayment

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

Response

{
  "id": "abc123def456",
  "paymentComplete": true,
  "companyId": "xyz789",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/salesOrderPayment

Delete a sales order payment

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/salesOrderPayment

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

204 No Content