The Asset Category object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

asset_category_name string required
enable_cwip_accounting boolean

Default: false

non_depreciable_category boolean

Default: false

The Asset Category object 
{
  "id": "asset-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset_category_name": "asset_category_name_example",
  "enable_cwip_accounting": false,
  "non_depreciable_category": false
}
GET /api/assets/asset-category/{id}

Retrieve a asset category

Retrieves the details of an existing asset category. Supply the unique asset category ID that was returned from a previous request.

Path parameters

id string required

The identifier of the asset category to retrieve.

Returns

Returns the asset category object if a valid identifier was provided.

GET /api/assets/asset-category/{id} 
curl https://api.overplane.dev/api/assets/asset-category/asset-category_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset_category_name": "asset_category_name_example",
  "enable_cwip_accounting": false,
  "non_depreciable_category": false
}
GET /api/assets/asset-category

List all asset categorys

Returns a list of asset categorys. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of asset category objects.

GET /api/assets/asset-category 
curl https://api.overplane.dev/api/assets/asset-category \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-category_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "asset_category_name": "asset_category_name_example",
      "enable_cwip_accounting": false,
      "non_depreciable_category": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-category

Create a asset category

Creates a new asset category object.

Body parameters

asset_category_name string required
enable_cwip_accounting boolean

Default: false

non_depreciable_category boolean

Default: false

Returns

Returns the newly created asset category object if the call succeeded.

POST /api/assets/asset-category 
curl https://api.overplane.dev/api/assets/asset-category \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"asset_category_name":"asset_category_name_example"}'
Response 
{
  "id": "asset-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset_category_name": "asset_category_name_example",
  "enable_cwip_accounting": false,
  "non_depreciable_category": false
}
PATCH /api/assets/asset-category/{id}

Update a asset category

Updates the specified asset category by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the asset category to update.

Body parameters

asset_category_name string
enable_cwip_accounting boolean

Default: false

non_depreciable_category boolean

Default: false

Returns

Returns the updated asset category object.

PATCH /api/assets/asset-category/{id} 
curl https://api.overplane.dev/api/assets/asset-category/asset-category_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"asset_category_name":"asset_category_name_example","enable_cwip_accounting":false}'
Response 
{
  "id": "asset-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset_category_name": "asset_category_name_example",
  "enable_cwip_accounting": false,
  "non_depreciable_category": false
}
DELETE /api/assets/asset-category/{id}

Delete a asset category

Permanently deletes a asset category. This cannot be undone.

Path parameters

id string required

The identifier of the asset category to delete.

Returns

Returns a confirmation that the asset category has been deleted.

DELETE /api/assets/asset-category/{id} 
curl https://api.overplane.dev/api/assets/asset-category/asset-category_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "asset-category_abc123",
  "deleted": true
}

Line items

Child objects that belong to this asset category. These are accessed via the parent's ID.

Asset Category Account

Attributes

idx integer
asset_category_id string required
company_name string required
fixed_asset_account string required
accumulated_depreciation_account string
depreciation_expense_account string
capital_work_in_progress_account string

Endpoints

GET /api/assets/asset-category-account?parent_id={id}
POST /api/assets/asset-category-account
PATCH /api/assets/asset-category-account/{id}
DELETE /api/assets/asset-category-account/{id}
POST /api/assets/asset-category-account/reorder
Asset Category Account object 
{
  "id": "asset-category-account_abc123",
  "idx": 1,
  "asset_category_id": "asset_category_id_example",
  "company_name": "Example Corp",
  "fixed_asset_account": "fixed_asset_account_example",
  "accumulated_depreciation_account": "accumulated_depreciation_account_example",
  "depreciation_expense_account": "depreciation_expense_account_example",
  "capital_work_in_progress_account": "capital_work_in_progress_account_example"
}