Accounts

The accounts resource.

Basehttps://rest.carbon.ms/accounts

GET/accounts

List accountss

Retrieve a paginated list of accountss. 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/accounts

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "number": "string",
    "class": "string",
    "incomeBalance": "string",
    "consolidatedRate": "string",
    "active": true,
    "createdBy": "string"
  }
]

GET/accounts

Retrieve a accounts

Fetch a single accounts by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/accounts

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "number": "string",
  "class": "string",
  "incomeBalance": "string",
  "consolidatedRate": "string",
  "active": true,
  "createdBy": "string"
}

POST/accounts

Create a accounts

Create a new accounts.

Body parameters

numberstring

namestring

classglAccountClass

incomeBalanceglIncomeBalance

consolidatedRateglConsolidatedRate

activeboolean

customFieldsobject

tagsarray

companyGroupIdstring

References companyGroup.id

parentIdstring

References account.id

isGroupboolean

accountTypeaccountType

isSystemboolean

POSThttps://rest.carbon.ms/accounts

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "number": "string",
  "class": "string",
  "incomeBalance": "string",
  "consolidatedRate": "string",
  "active": true,
  "createdBy": "string"
}

PATCH/accounts

Update a accounts

Update an existing accounts, matched on `id`.

Body parameters

numberstring

namestring

classglAccountClass

incomeBalanceglIncomeBalance

consolidatedRateglConsolidatedRate

activeboolean

customFieldsobject

tagsarray

companyGroupIdstring

References companyGroup.id

parentIdstring

References account.id

isGroupboolean

accountTypeaccountType

isSystemboolean

PATCHhttps://rest.carbon.ms/accounts

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "number": "string",
  "class": "string",
  "incomeBalance": "string",
  "consolidatedRate": "string",
  "active": true,
  "createdBy": "string"
}

DELETE/accounts

Delete a accounts

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/accounts

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

204 No Content