Carbon

Terms

The terms resource.

Basehttps://rest.carbon.ms/terms
GET/terms

List termss

Retrieve a paginated list of termss. 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/terms
curl --request GET \
  --url 'https://rest.carbon.ms/terms?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "purchasingTerms": "string",
    "salesTerms": "string",
    "updatedAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string"
  }
]
GET/terms

Retrieve a terms

Fetch a single terms by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/terms
curl --request GET \
  --url 'https://rest.carbon.ms/terms?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "purchasingTerms": "string",
  "salesTerms": "string",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
POST/terms

Create a terms

Create a new terms.

Body parameters

purchasingTermsobject
salesTermsobject
POSThttps://rest.carbon.ms/terms
curl --request POST \
  --url https://rest.carbon.ms/terms \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"id":"abc123def456"}'
Response
{
  "id": "abc123def456",
  "purchasingTerms": "string",
  "salesTerms": "string",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
PATCH/terms

Update a terms

Update an existing terms, matched on `id`.

Body parameters

purchasingTermsobject
salesTermsobject
PATCHhttps://rest.carbon.ms/terms
curl --request PATCH \
  --url 'https://rest.carbon.ms/terms?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"purchasingTerms":"string"}'
Response
{
  "id": "abc123def456",
  "purchasingTerms": "string",
  "salesTerms": "string",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
DELETE/terms

Delete a terms

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

Query parameters

idstring

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

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