Supplier

The supplier resource.

Basehttps://rest.carbon.ms/supplier

GET/supplier

List suppliers

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

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "taxPercent": 0,
    "supplierTypeId": "xyz789",
    "accountManagerId": "xyz789",
    "logo": "string"
  }
]

GET/supplier

Retrieve a supplier

Fetch a single supplier by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/supplier

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "taxPercent": 0,
  "supplierTypeId": "xyz789",
  "accountManagerId": "xyz789",
  "logo": "string"
}

POST/supplier

Create a supplier

Create a new supplier.

Body parameters

namestringrequired

supplierTypeIdstring

References supplierType.id

accountManagerIdstring

References user.id

logostring

assigneestring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

currencyCodestring

References currencyCode.code

phonestring

faxstring

websitestring

tagsarray

taxPercentnumberrequired

embeddingstring

purchasingContactIdstring

References supplierContact.id

defaultCcarray

supplierStatussupplierStatusType

intercompanyCompanyIdstring

References company.id

POSThttps://rest.carbon.ms/supplier

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "taxPercent": 0,
  "supplierTypeId": "xyz789",
  "accountManagerId": "xyz789",
  "logo": "string"
}

PATCH/supplier

Update a supplier

Update an existing supplier, matched on `id`.

Body parameters

namestringrequired

supplierTypeIdstring

References supplierType.id

accountManagerIdstring

References user.id

logostring

assigneestring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

currencyCodestring

References currencyCode.code

phonestring

faxstring

websitestring

tagsarray

taxPercentnumberrequired

embeddingstring

purchasingContactIdstring

References supplierContact.id

defaultCcarray

supplierStatussupplierStatusType

intercompanyCompanyIdstring

References company.id

PATCHhttps://rest.carbon.ms/supplier

curl --request PATCH \
  --url 'https://rest.carbon.ms/supplier?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",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "taxPercent": 0,
  "supplierTypeId": "xyz789",
  "accountManagerId": "xyz789",
  "logo": "string"
}

DELETE/supplier

Delete a supplier

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/supplier

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

204 No Content