Accounting Period

The accounting period resource.

Basehttps://rest.carbon.ms/accountingPeriod

GET/accountingPeriod

List accounting periods

Retrieve a paginated list of accounting periods. 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/accountingPeriod

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

Response

[
  {
    "id": "abc123def456",
    "startDate": "2026-01-01",
    "endDate": "2026-01-01",
    "status": "string",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "closedAt": "2026-01-01T00:00:00Z"
  }
]

GET/accountingPeriod

Retrieve a accounting period

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/accountingPeriod

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

Response

{
  "id": "abc123def456",
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "status": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "closedAt": "2026-01-01T00:00:00Z"
}

POST/accountingPeriod

Create a accounting period

Create a new accounting period.

Body parameters

startDatedaterequired

endDatedaterequired

statusaccountingPeriodStatusrequired

companyIdstringrequired

References company.id

closedAttimestamp

closedBystring

References user.id

POSThttps://rest.carbon.ms/accountingPeriod

curl --request POST \
  --url https://rest.carbon.ms/accountingPeriod \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"startDate":"2026-01-01","endDate":"2026-01-01","status":"string","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "status": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "closedAt": "2026-01-01T00:00:00Z"
}

PATCH/accountingPeriod

Update a accounting period

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

Body parameters

startDatedaterequired

endDatedaterequired

statusaccountingPeriodStatusrequired

companyIdstringrequired

References company.id

closedAttimestamp

closedBystring

References user.id

PATCHhttps://rest.carbon.ms/accountingPeriod

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

Response

{
  "id": "abc123def456",
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "status": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "closedAt": "2026-01-01T00:00:00Z"
}

DELETE/accountingPeriod

Delete a accounting period

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/accountingPeriod

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

204 No Content