The Asset Finance Book object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
finance_book string
depreciation_method string required
total_number_of_depreciations integer required
frequency_of_depreciation integer required
depreciation_start_date string
expected_value_after_useful_life number

Default: 0

value_after_depreciation number
rate_of_depreciation number
salvage_value_percentage number
daily_prorata_based boolean

Default: false

shift_based boolean

Default: false

total_number_of_booked_depreciations integer

Default: 0

increase_in_asset_life integer
The Asset Finance Book object 
{
  "id": "asset-finance-book_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "total_number_of_depreciations": 0,
  "frequency_of_depreciation": 0,
  "depreciation_start_date": "2024-01-15",
  "expected_value_after_useful_life": 0,
  "value_after_depreciation": 0,
  "rate_of_depreciation": 0,
  "salvage_value_percentage": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "total_number_of_booked_depreciations": 0,
  "increase_in_asset_life": 0
}
GET /api/assets/asset-finance-book?parent_id={id}

List asset finance books by parent

Returns all asset finance books belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of asset finance book objects belonging to the parent.

GET /api/assets/asset-finance-book?parent_id={id} 
curl https://api.overplane.dev/api/assets/asset-finance-book?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-finance-book_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "finance_book": "finance_book_example",
      "depreciation_method": "depreciation_method_example",
      "total_number_of_depreciations": 0,
      "frequency_of_depreciation": 0,
      "depreciation_start_date": "2024-01-15",
      "expected_value_after_useful_life": 0,
      "value_after_depreciation": 0,
      "rate_of_depreciation": 0,
      "salvage_value_percentage": 0,
      "daily_prorata_based": false,
      "shift_based": false,
      "total_number_of_booked_depreciations": 0,
      "increase_in_asset_life": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-finance-book

Create a asset finance book

Creates a new asset finance book object.

Body parameters

idx integer
parent_id string required
parent_type string required
finance_book string
depreciation_method string required
total_number_of_depreciations integer required
frequency_of_depreciation integer required
depreciation_start_date string
expected_value_after_useful_life number

Default: 0

value_after_depreciation number
rate_of_depreciation number
salvage_value_percentage number
daily_prorata_based boolean

Default: false

shift_based boolean

Default: false

total_number_of_booked_depreciations integer

Default: 0

increase_in_asset_life integer

Returns

Returns the newly created asset finance book object if the call succeeded.

POST /api/assets/asset-finance-book 
curl https://api.overplane.dev/api/assets/asset-finance-book \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","depreciation_method":"depreciation_method_example","total_number_of_depreciations":0,"frequency_of_depreciation":0}'
Response 
{
  "id": "asset-finance-book_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "total_number_of_depreciations": 0,
  "frequency_of_depreciation": 0,
  "depreciation_start_date": "2024-01-15",
  "expected_value_after_useful_life": 0,
  "value_after_depreciation": 0,
  "rate_of_depreciation": 0,
  "salvage_value_percentage": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "total_number_of_booked_depreciations": 0,
  "increase_in_asset_life": 0
}
PATCH /api/assets/asset-finance-book/{id}

Update a asset finance book

Updates the specified asset finance book 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 finance book to update.

Body parameters

idx integer
parent_id string
parent_type string
finance_book string
depreciation_method string
total_number_of_depreciations integer
frequency_of_depreciation integer
depreciation_start_date string
expected_value_after_useful_life number

Default: 0

value_after_depreciation number
rate_of_depreciation number
salvage_value_percentage number
daily_prorata_based boolean

Default: false

shift_based boolean

Default: false

total_number_of_booked_depreciations integer

Default: 0

increase_in_asset_life integer

Returns

Returns the updated asset finance book object.

PATCH /api/assets/asset-finance-book/{id} 
curl https://api.overplane.dev/api/assets/asset-finance-book/asset-finance-book_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "asset-finance-book_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "total_number_of_depreciations": 0,
  "frequency_of_depreciation": 0,
  "depreciation_start_date": "2024-01-15",
  "expected_value_after_useful_life": 0,
  "value_after_depreciation": 0,
  "rate_of_depreciation": 0,
  "salvage_value_percentage": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "total_number_of_booked_depreciations": 0,
  "increase_in_asset_life": 0
}
DELETE /api/assets/asset-finance-book/{id}

Delete a asset finance book

Permanently deletes a asset finance book. This cannot be undone.

Path parameters

id string required

The identifier of the asset finance book to delete.

Returns

Returns a confirmation that the asset finance book has been deleted.

DELETE /api/assets/asset-finance-book/{id} 
curl https://api.overplane.dev/api/assets/asset-finance-book/asset-finance-book_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "asset-finance-book_abc123",
  "deleted": true
}
POST /api/assets/asset-finance-book/reorder

Reorder asset finance books

Updates the sort order of asset finance books within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/assets/asset-finance-book/reorder 
curl https://api.overplane.dev/api/assets/asset-finance-book/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-finance-book_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "total_number_of_depreciations": 0,
  "frequency_of_depreciation": 0,
  "depreciation_start_date": "2024-01-15",
  "expected_value_after_useful_life": 0,
  "value_after_depreciation": 0,
  "rate_of_depreciation": 0,
  "salvage_value_percentage": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "total_number_of_booked_depreciations": 0,
  "increase_in_asset_life": 0
}