The Asset Depreciation Schedule 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.

status string

Default: draft

asset string required
finance_book string
depreciation_method string
rate_of_depreciation number
total_number_of_depreciations integer
notes string
frequency_of_depreciation integer
expected_value_after_useful_life number
finance_book_id integer
opening_accumulated_depreciation number
opening_number_of_booked_depreciations integer
daily_prorata_based boolean

Default: false

shift_based boolean

Default: false

company string
value_after_depreciation number
net_purchase_amount number
The Asset Depreciation Schedule object 
{
  "id": "asset-depreciation-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset": "asset_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "rate_of_depreciation": 0,
  "total_number_of_depreciations": 0,
  "notes": "notes_example",
  "frequency_of_depreciation": 0,
  "expected_value_after_useful_life": 0,
  "finance_book_id": 0,
  "opening_accumulated_depreciation": 0,
  "opening_number_of_booked_depreciations": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "company": "Example Corp",
  "value_after_depreciation": 0,
  "net_purchase_amount": 0
}
GET /api/assets/asset-depreciation-schedule/{id}

Retrieve a asset depreciation schedule

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

Path parameters

id string required

The identifier of the asset depreciation schedule to retrieve.

Returns

Returns the asset depreciation schedule object if a valid identifier was provided.

GET /api/assets/asset-depreciation-schedule/{id} 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule/asset-depreciation-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-depreciation-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset": "asset_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "rate_of_depreciation": 0,
  "total_number_of_depreciations": 0,
  "notes": "notes_example",
  "frequency_of_depreciation": 0,
  "expected_value_after_useful_life": 0,
  "finance_book_id": 0,
  "opening_accumulated_depreciation": 0,
  "opening_number_of_booked_depreciations": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "company": "Example Corp",
  "value_after_depreciation": 0,
  "net_purchase_amount": 0
}
GET /api/assets/asset-depreciation-schedule

List all asset depreciation schedules

Returns a list of asset depreciation schedules. 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 depreciation schedule objects.

GET /api/assets/asset-depreciation-schedule 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-depreciation-schedule_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "asset": "asset_example",
      "finance_book": "finance_book_example",
      "depreciation_method": "depreciation_method_example",
      "rate_of_depreciation": 0,
      "total_number_of_depreciations": 0,
      "notes": "notes_example",
      "frequency_of_depreciation": 0,
      "expected_value_after_useful_life": 0,
      "finance_book_id": 0,
      "opening_accumulated_depreciation": 0,
      "opening_number_of_booked_depreciations": 0,
      "daily_prorata_based": false,
      "shift_based": false,
      "company": "Example Corp",
      "value_after_depreciation": 0,
      "net_purchase_amount": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-depreciation-schedule

Create a asset depreciation schedule

Creates a new asset depreciation schedule object.

Body parameters

status string

Default: draft

asset string required
finance_book string
depreciation_method string
rate_of_depreciation number
total_number_of_depreciations integer
notes string
frequency_of_depreciation integer
expected_value_after_useful_life number
finance_book_id integer
opening_accumulated_depreciation number
opening_number_of_booked_depreciations integer
daily_prorata_based boolean

Default: false

shift_based boolean

Default: false

company string
value_after_depreciation number
net_purchase_amount number

Returns

Returns the newly created asset depreciation schedule object if the call succeeded.

POST /api/assets/asset-depreciation-schedule 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"asset":"asset_example"}'
Response 
{
  "id": "asset-depreciation-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset": "asset_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "rate_of_depreciation": 0,
  "total_number_of_depreciations": 0,
  "notes": "notes_example",
  "frequency_of_depreciation": 0,
  "expected_value_after_useful_life": 0,
  "finance_book_id": 0,
  "opening_accumulated_depreciation": 0,
  "opening_number_of_booked_depreciations": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "company": "Example Corp",
  "value_after_depreciation": 0,
  "net_purchase_amount": 0
}
PATCH /api/assets/asset-depreciation-schedule/{id}

Update a asset depreciation schedule

Updates the specified asset depreciation schedule 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 depreciation schedule to update.

Body parameters

status string

Default: draft

asset string
finance_book string
depreciation_method string
rate_of_depreciation number
total_number_of_depreciations integer
notes string
frequency_of_depreciation integer
expected_value_after_useful_life number
finance_book_id integer
opening_accumulated_depreciation number
opening_number_of_booked_depreciations integer
daily_prorata_based boolean

Default: false

shift_based boolean

Default: false

company string
value_after_depreciation number
net_purchase_amount number

Returns

Returns the updated asset depreciation schedule object.

PATCH /api/assets/asset-depreciation-schedule/{id} 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule/asset-depreciation-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","asset":"asset_example"}'
Response 
{
  "id": "asset-depreciation-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset": "asset_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "rate_of_depreciation": 0,
  "total_number_of_depreciations": 0,
  "notes": "notes_example",
  "frequency_of_depreciation": 0,
  "expected_value_after_useful_life": 0,
  "finance_book_id": 0,
  "opening_accumulated_depreciation": 0,
  "opening_number_of_booked_depreciations": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "company": "Example Corp",
  "value_after_depreciation": 0,
  "net_purchase_amount": 0
}
DELETE /api/assets/asset-depreciation-schedule/{id}

Delete a asset depreciation schedule

Permanently deletes a asset depreciation schedule. This cannot be undone.

Path parameters

id string required

The identifier of the asset depreciation schedule to delete.

Returns

Returns a confirmation that the asset depreciation schedule has been deleted.

DELETE /api/assets/asset-depreciation-schedule/{id} 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule/asset-depreciation-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "asset-depreciation-schedule_abc123",
  "deleted": true
}
POST /api/assets/asset-depreciation-schedule/{id}/submit

Submit a asset depreciation schedule

Submits a draft asset depreciation schedule, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the asset depreciation schedule to act on.

Returns

Returns the asset depreciation schedule object with updated status.

POST /api/assets/asset-depreciation-schedule/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule/asset-depreciation-schedule_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-depreciation-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset": "asset_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "rate_of_depreciation": 0,
  "total_number_of_depreciations": 0,
  "notes": "notes_example",
  "frequency_of_depreciation": 0,
  "expected_value_after_useful_life": 0,
  "finance_book_id": 0,
  "opening_accumulated_depreciation": 0,
  "opening_number_of_booked_depreciations": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "company": "Example Corp",
  "value_after_depreciation": 0,
  "net_purchase_amount": 0
}
POST /api/assets/asset-depreciation-schedule/{id}/cancel

Cancel a asset depreciation schedule

Cancels a submitted asset depreciation schedule, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the asset depreciation schedule to act on.

Returns

Returns the asset depreciation schedule object with updated status.

POST /api/assets/asset-depreciation-schedule/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-depreciation-schedule/asset-depreciation-schedule_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-depreciation-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset": "asset_example",
  "finance_book": "finance_book_example",
  "depreciation_method": "depreciation_method_example",
  "rate_of_depreciation": 0,
  "total_number_of_depreciations": 0,
  "notes": "notes_example",
  "frequency_of_depreciation": 0,
  "expected_value_after_useful_life": 0,
  "finance_book_id": 0,
  "opening_accumulated_depreciation": 0,
  "opening_number_of_booked_depreciations": 0,
  "daily_prorata_based": false,
  "shift_based": false,
  "company": "Example Corp",
  "value_after_depreciation": 0,
  "net_purchase_amount": 0
}