Supplier Payment

The supplier payment resource.

Basehttps://rest.carbon.ms/supplierPayment

GET/supplierPayment

List supplier payments

Retrieve a paginated list of supplier 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/supplierPayment

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

Response

[
  {
    "supplierId": "xyz789",
    "companyId": "xyz789",
    "invoiceSupplierId": "xyz789",
    "invoiceSupplierLocationId": "xyz789",
    "invoiceSupplierContactId": "xyz789",
    "paymentTermId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string"
  }
]

GET/supplierPayment

Retrieve a supplier payment

Fetch a single supplier payment by filtering on `supplierId`.

Query parameters

supplierIdstring

Match on the supplier payment's `supplierId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplierPayment

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

Response

{
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "invoiceSupplierId": "xyz789",
  "invoiceSupplierLocationId": "xyz789",
  "invoiceSupplierContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

POST/supplierPayment

Create a supplier payment

Create a new supplier payment.

Body parameters

invoiceSupplierIdstring

References supplier.id

invoiceSupplierLocationIdstring

References supplierLocation.id

invoiceSupplierContactIdstring

References supplierContact.id

paymentTermIdstring

References paymentTerm.id

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/supplierPayment

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

Response

{
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "invoiceSupplierId": "xyz789",
  "invoiceSupplierLocationId": "xyz789",
  "invoiceSupplierContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

PATCH/supplierPayment

Update a supplier payment

Update an existing supplier payment, matched on `supplierId`.

Body parameters

invoiceSupplierIdstring

References supplier.id

invoiceSupplierLocationIdstring

References supplierLocation.id

invoiceSupplierContactIdstring

References supplierContact.id

paymentTermIdstring

References paymentTerm.id

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/supplierPayment

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

Response

{
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "invoiceSupplierId": "xyz789",
  "invoiceSupplierLocationId": "xyz789",
  "invoiceSupplierContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

DELETE/supplierPayment

Delete a supplier payment

Delete a supplier payment, matched on `supplierId`. Returns 204 No Content.

Query parameters

supplierIdstring

The `supplierId` of the supplier payment to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/supplierPayment

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

204 No Content