Carbon

Accounting Period Balance

The accounting period balance resource.

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

List accounting period balances

Retrieve a paginated list of accounting period balances. 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/accountingPeriodBalance
curl --request GET \
  --url 'https://rest.carbon.ms/accountingPeriodBalance?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "accountingPeriodId": "xyz789",
    "accountId": "xyz789",
    "endingBalance": 0,
    "endingBalanceDate": "2026-01-01",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/accountingPeriodBalance

Retrieve a accounting period balance

Fetch a single accounting period balance by filtering on `id`.

Query parameters

idstring

Match on the accounting period balance's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/accountingPeriodBalance
curl --request GET \
  --url 'https://rest.carbon.ms/accountingPeriodBalance?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "accountingPeriodId": "xyz789",
  "accountId": "xyz789",
  "endingBalance": 0,
  "endingBalanceDate": "2026-01-01",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/accountingPeriodBalance

Create a accounting period balance

Create a new accounting period balance.

Body parameters

accountingPeriodIdstringrequired

References accountingPeriod.id

accountIdstringrequired

References account.id

endingBalancenumberrequired
endingBalanceDatedaterequired
POSThttps://rest.carbon.ms/accountingPeriodBalance
curl --request POST \
  --url https://rest.carbon.ms/accountingPeriodBalance \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"accountingPeriodId":"xyz789","accountId":"xyz789","endingBalance":0,"endingBalanceDate":"2026-01-01"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "accountingPeriodId": "xyz789",
  "accountId": "xyz789",
  "endingBalance": 0,
  "endingBalanceDate": "2026-01-01",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/accountingPeriodBalance

Update a accounting period balance

Update an existing accounting period balance, matched on `id`.

Body parameters

accountingPeriodIdstringrequired

References accountingPeriod.id

accountIdstringrequired

References account.id

endingBalancenumberrequired
endingBalanceDatedaterequired
PATCHhttps://rest.carbon.ms/accountingPeriodBalance
curl --request PATCH \
  --url 'https://rest.carbon.ms/accountingPeriodBalance?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"accountingPeriodId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "accountingPeriodId": "xyz789",
  "accountId": "xyz789",
  "endingBalance": 0,
  "endingBalanceDate": "2026-01-01",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/accountingPeriodBalance

Delete a accounting period balance

Delete a accounting period balance, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the accounting period balance to delete, e.g. `eq.{id}`.

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