Purchase Order Payment

The purchase order payment resource.

Basehttps://rest.carbon.ms/purchaseOrderPayment

GET/purchaseOrderPayment

List purchase order payments

Retrieve a paginated list of purchase 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/purchaseOrderPayment

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

Response

[
  {
    "id": "abc123def456",
    "paymentComplete": true,
    "companyId": "xyz789",
    "invoiceSupplierId": "xyz789",
    "invoiceSupplierLocationId": "xyz789",
    "invoiceSupplierContactId": "xyz789",
    "paymentTermId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/purchaseOrderPayment

Retrieve a purchase order payment

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/purchaseOrderPayment

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

Response

{
  "id": "abc123def456",
  "paymentComplete": true,
  "companyId": "xyz789",
  "invoiceSupplierId": "xyz789",
  "invoiceSupplierLocationId": "xyz789",
  "invoiceSupplierContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/purchaseOrderPayment

Create a purchase order payment

Create a new purchase order payment.

Body parameters

invoiceSupplierIdstring

References supplier.id

invoiceSupplierLocationIdstring

References supplierLocation.id

invoiceSupplierContactIdstring

References supplierContact.id

paymentTermIdstring

References paymentTerm.id

paymentCompletebooleanrequired

companyIdstringrequired

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/purchaseOrderPayment

curl --request POST \
  --url https://rest.carbon.ms/purchaseOrderPayment \
  --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",
  "invoiceSupplierId": "xyz789",
  "invoiceSupplierLocationId": "xyz789",
  "invoiceSupplierContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/purchaseOrderPayment

Update a purchase order payment

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

Body parameters

invoiceSupplierIdstring

References supplier.id

invoiceSupplierLocationIdstring

References supplierLocation.id

invoiceSupplierContactIdstring

References supplierContact.id

paymentTermIdstring

References paymentTerm.id

paymentCompletebooleanrequired

companyIdstringrequired

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/purchaseOrderPayment

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

Response

{
  "id": "abc123def456",
  "paymentComplete": true,
  "companyId": "xyz789",
  "invoiceSupplierId": "xyz789",
  "invoiceSupplierLocationId": "xyz789",
  "invoiceSupplierContactId": "xyz789",
  "paymentTermId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/purchaseOrderPayment

Delete a purchase order payment

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/purchaseOrderPayment

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

204 No Content