Accounting Sync Tie Out

The accounting sync tie out resource.

Basehttps://rest.carbon.ms/accountingSyncTieOut

GET/accountingSyncTieOut

List accounting sync tie outs

Retrieve a paginated list of accounting sync tie outs. 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/accountingSyncTieOut

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "integration": "string",
    "accountingPeriodId": "xyz789",
    "accountId": "xyz789",
    "carbonPostedAmount": 0,
    "syncedAmount": 0,
    "docBackedAmount": 0
  }
]

GET/accountingSyncTieOut

Retrieve a accounting sync tie out

Fetch a single accounting sync tie out by filtering on `id`.

Query parameters

idstring

Match on the accounting sync tie out's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/accountingSyncTieOut

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "integration": "string",
  "accountingPeriodId": "xyz789",
  "accountId": "xyz789",
  "carbonPostedAmount": 0,
  "syncedAmount": 0,
  "docBackedAmount": 0
}

POST/accountingSyncTieOut

Create a accounting sync tie out

Create a new accounting sync tie out.

Body parameters

integrationstringrequired

accountingPeriodIdstringrequired

References accountingPeriod.id

accountIdstringrequired

References account.id

carbonPostedAmountnumberrequired

syncedAmountnumberrequired

docBackedAmountnumberrequired

excludedAmountnumberrequired

pendingAmountnumberrequired

blockedAmountnumberrequired

providerAmountnumber

internalDeltanumberrequired

externalDeltanumber

computedAttimestamprequired

POSThttps://rest.carbon.ms/accountingSyncTieOut

curl --request POST \
  --url https://rest.carbon.ms/accountingSyncTieOut \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"integration":"string","accountingPeriodId":"xyz789","accountId":"xyz789","carbonPostedAmount":0,"syncedAmount":0,"docBackedAmount":0,"excludedAmount":0,"pendingAmount":0,"blockedAmount":0,"internalDelta":0,"computedAt":"2026-01-01T00:00:00Z"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "integration": "string",
  "accountingPeriodId": "xyz789",
  "accountId": "xyz789",
  "carbonPostedAmount": 0,
  "syncedAmount": 0,
  "docBackedAmount": 0
}

PATCH/accountingSyncTieOut

Update a accounting sync tie out

Update an existing accounting sync tie out, matched on `id`.

Body parameters

integrationstringrequired

accountingPeriodIdstringrequired

References accountingPeriod.id

accountIdstringrequired

References account.id

carbonPostedAmountnumberrequired

syncedAmountnumberrequired

docBackedAmountnumberrequired

excludedAmountnumberrequired

pendingAmountnumberrequired

blockedAmountnumberrequired

providerAmountnumber

internalDeltanumberrequired

externalDeltanumber

computedAttimestamprequired

PATCHhttps://rest.carbon.ms/accountingSyncTieOut

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "integration": "string",
  "accountingPeriodId": "xyz789",
  "accountId": "xyz789",
  "carbonPostedAmount": 0,
  "syncedAmount": 0,
  "docBackedAmount": 0
}

DELETE/accountingSyncTieOut

Delete a accounting sync tie out

Delete a accounting sync tie out, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the accounting sync tie out to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/accountingSyncTieOut

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

204 No Content