Customer Payment

The customer payment resource.

Basehttps://rest.carbon.ms/customerPayment

GET/customerPayment

List customer payments

Retrieve a paginated list of customer 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/customerPayment

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

Response

[
  {
    "customerId": "xyz789",
    "companyId": "xyz789",
    "invoiceCustomerId": "xyz789",
    "invoiceCustomerLocationId": "xyz789",
    "invoiceCustomerContactId": "xyz789",
    "paymentTermId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string"
  }
]

GET/customerPayment

Retrieve a customer payment

Fetch a single customer payment by filtering on `customerId`.

Query parameters

customerIdstring

Match on the customer payment's `customerId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/customerPayment

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

Response

{
  "customerId": "xyz789",
  "companyId": "xyz789",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

POST/customerPayment

Create a customer payment

Create a new customer payment.

Body parameters

invoiceCustomerIdstring

References customer.id

invoiceCustomerLocationIdstring

References customerLocation.id

invoiceCustomerContactIdstring

References customerContact.id

paymentTermIdstring

References paymentTerm.id

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/customerPayment

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

Response

{
  "customerId": "xyz789",
  "companyId": "xyz789",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

PATCH/customerPayment

Update a customer payment

Update an existing customer payment, matched on `customerId`.

Body parameters

invoiceCustomerIdstring

References customer.id

invoiceCustomerLocationIdstring

References customerLocation.id

invoiceCustomerContactIdstring

References customerContact.id

paymentTermIdstring

References paymentTerm.id

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/customerPayment

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

Response

{
  "customerId": "xyz789",
  "companyId": "xyz789",
  "invoiceCustomerId": "xyz789",
  "invoiceCustomerLocationId": "xyz789",
  "invoiceCustomerContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

DELETE/customerPayment

Delete a customer payment

Delete a customer payment, matched on `customerId`. Returns 204 No Content.

Query parameters

customerIdstring

The `customerId` of the customer payment to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/customerPayment

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

204 No Content