Payment Term

The payment term resource.

Basehttps://rest.carbon.ms/paymentTerm

GET/paymentTerm

List payment terms

Retrieve a paginated list of payment terms. 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/paymentTerm

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "daysDue": 0,
    "daysDiscount": 10,
    "discountPercentage": 10,
    "calculationMethod": "string",
    "active": true,
    "companyId": "xyz789"
  }
]

GET/paymentTerm

Retrieve a payment term

Fetch a single payment term by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/paymentTerm

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "daysDue": 0,
  "daysDiscount": 10,
  "discountPercentage": 10,
  "calculationMethod": "string",
  "active": true,
  "companyId": "xyz789"
}

POST/paymentTerm

Create a payment term

Create a new payment term.

Body parameters

namestringrequired

daysDuenumberrequired

daysDiscountnumberrequired

discountPercentagenumberrequired

calculationMethodpaymentTermCalculationMethodrequired

activebooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/paymentTerm

curl --request POST \
  --url https://rest.carbon.ms/paymentTerm \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","daysDue":0,"daysDiscount":10,"discountPercentage":10,"calculationMethod":"string","active":true,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "daysDue": 0,
  "daysDiscount": 10,
  "discountPercentage": 10,
  "calculationMethod": "string",
  "active": true,
  "companyId": "xyz789"
}

PATCH/paymentTerm

Update a payment term

Update an existing payment term, matched on `id`.

Body parameters

namestringrequired

daysDuenumberrequired

daysDiscountnumberrequired

discountPercentagenumberrequired

calculationMethodpaymentTermCalculationMethodrequired

activebooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/paymentTerm

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "daysDue": 0,
  "daysDiscount": 10,
  "discountPercentage": 10,
  "calculationMethod": "string",
  "active": true,
  "companyId": "xyz789"
}

DELETE/paymentTerm

Delete a payment term

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/paymentTerm

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

204 No Content