Fixed Asset Class

The fixed asset class resource.

Basehttps://rest.carbon.ms/fixedAssetClass

GET/fixedAssetClass

List fixed asset classes

Retrieve a paginated list of fixed asset classes. 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/fixedAssetClass

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "depreciationMethod": "string",
    "usefulLifeMonths": 0,
    "residualValuePercent": 0,
    "assetAccountId": "xyz789",
    "accumulatedDepreciationAccountId": "xyz789",
    "depreciationExpenseAccountId": "xyz789"
  }
]

GET/fixedAssetClass

Retrieve a fixed asset class

Fetch a single fixed asset class by filtering on `id`.

Query parameters

idstring

Match on the fixed asset class's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/fixedAssetClass

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "depreciationMethod": "string",
  "usefulLifeMonths": 0,
  "residualValuePercent": 0,
  "assetAccountId": "xyz789",
  "accumulatedDepreciationAccountId": "xyz789",
  "depreciationExpenseAccountId": "xyz789"
}

POST/fixedAssetClass

Create a fixed asset class

Create a new fixed asset class.

Body parameters

namestringrequired

descriptionstring

depreciationMethoddepreciationMethodrequired

usefulLifeMonthsnumberrequired

residualValuePercentnumberrequired

assetAccountIdstringrequired

References account.id

accumulatedDepreciationAccountIdstringrequired

References account.id

depreciationExpenseAccountIdstringrequired

References account.id

writeOffAccountIdstringrequired

References account.id

writeDownAccountIdstringrequired

References account.id

disposalAccountIdstringrequired

References account.id

taxDepreciationMethodtaxDepreciationMethod

taxUsefulLifeMonthsnumber

taxResidualValuePercentnumber

macrsPropertyClassmacrsPropertyClass

macrsConventionmacrsConvention

bonusDepreciationPercentnumber

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/fixedAssetClass

curl --request POST \
  --url https://rest.carbon.ms/fixedAssetClass \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","depreciationMethod":"string","usefulLifeMonths":0,"residualValuePercent":0,"assetAccountId":"xyz789","accumulatedDepreciationAccountId":"xyz789","depreciationExpenseAccountId":"xyz789","writeOffAccountId":"xyz789","writeDownAccountId":"xyz789","disposalAccountId":"xyz789","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "depreciationMethod": "string",
  "usefulLifeMonths": 0,
  "residualValuePercent": 0,
  "assetAccountId": "xyz789",
  "accumulatedDepreciationAccountId": "xyz789",
  "depreciationExpenseAccountId": "xyz789"
}

PATCH/fixedAssetClass

Update a fixed asset class

Update an existing fixed asset class, matched on `id`.

Body parameters

namestringrequired

descriptionstring

depreciationMethoddepreciationMethodrequired

usefulLifeMonthsnumberrequired

residualValuePercentnumberrequired

assetAccountIdstringrequired

References account.id

accumulatedDepreciationAccountIdstringrequired

References account.id

depreciationExpenseAccountIdstringrequired

References account.id

writeOffAccountIdstringrequired

References account.id

writeDownAccountIdstringrequired

References account.id

disposalAccountIdstringrequired

References account.id

taxDepreciationMethodtaxDepreciationMethod

taxUsefulLifeMonthsnumber

taxResidualValuePercentnumber

macrsPropertyClassmacrsPropertyClass

macrsConventionmacrsConvention

bonusDepreciationPercentnumber

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/fixedAssetClass

curl --request PATCH \
  --url 'https://rest.carbon.ms/fixedAssetClass?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",
  "depreciationMethod": "string",
  "usefulLifeMonths": 0,
  "residualValuePercent": 0,
  "assetAccountId": "xyz789",
  "accumulatedDepreciationAccountId": "xyz789",
  "depreciationExpenseAccountId": "xyz789"
}

DELETE/fixedAssetClass

Delete a fixed asset class

Delete a fixed asset class, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the fixed asset class to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/fixedAssetClass

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

204 No Content