The Asset Capitalization 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

title string
target_item_code string
target_asset string
target_asset_name string
company string required
posting_date string required
posting_time string required
set_posting_time boolean

Default: false

stock_items_total number
asset_items_total number
finance_book string
service_items_total number
total_value number
target_incoming_rate number
cost_center string
project string
target_fixed_asset_account string
The Asset Capitalization object 
{
  "id": "asset-capitalization_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "target_item_code": "target_item_code_example",
  "target_asset": "target_asset_example",
  "target_asset_name": "target_asset_name_example",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "stock_items_total": 0,
  "asset_items_total": 0,
  "finance_book": "finance_book_example",
  "service_items_total": 0,
  "total_value": 0,
  "target_incoming_rate": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "target_fixed_asset_account": "target_fixed_asset_account_example"
}
GET /api/assets/asset-capitalization/{id}

Retrieve a asset capitalization

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

Path parameters

id string required

The identifier of the asset capitalization to retrieve.

Returns

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

GET /api/assets/asset-capitalization/{id} 
curl https://api.overplane.dev/api/assets/asset-capitalization/asset-capitalization_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-capitalization_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "target_item_code": "target_item_code_example",
  "target_asset": "target_asset_example",
  "target_asset_name": "target_asset_name_example",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "stock_items_total": 0,
  "asset_items_total": 0,
  "finance_book": "finance_book_example",
  "service_items_total": 0,
  "total_value": 0,
  "target_incoming_rate": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "target_fixed_asset_account": "target_fixed_asset_account_example"
}
GET /api/assets/asset-capitalization

List all asset capitalizations

Returns a list of asset capitalizations. 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 capitalization objects.

GET /api/assets/asset-capitalization 
curl https://api.overplane.dev/api/assets/asset-capitalization \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-capitalization_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "title": "title_example",
      "target_item_code": "target_item_code_example",
      "target_asset": "target_asset_example",
      "target_asset_name": "target_asset_name_example",
      "company": "Example Corp",
      "posting_date": "2024-01-15",
      "posting_time": "posting_time_example",
      "set_posting_time": false,
      "stock_items_total": 0,
      "asset_items_total": 0,
      "finance_book": "finance_book_example",
      "service_items_total": 0,
      "total_value": 0,
      "target_incoming_rate": 0,
      "cost_center": "cost_center_example",
      "project": "project_example",
      "target_fixed_asset_account": "target_fixed_asset_account_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-capitalization

Create a asset capitalization

Creates a new asset capitalization object.

Body parameters

status string

Default: draft

title string
target_item_code string
target_asset string
target_asset_name string
company string required
posting_date string required
posting_time string required
set_posting_time boolean

Default: false

stock_items_total number
asset_items_total number
finance_book string
service_items_total number
total_value number
target_incoming_rate number
cost_center string
project string
target_fixed_asset_account string

Returns

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

POST /api/assets/asset-capitalization 
curl https://api.overplane.dev/api/assets/asset-capitalization \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","posting_date":"2024-01-15","posting_time":"posting_time_example"}'
Response 
{
  "id": "asset-capitalization_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "target_item_code": "target_item_code_example",
  "target_asset": "target_asset_example",
  "target_asset_name": "target_asset_name_example",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "stock_items_total": 0,
  "asset_items_total": 0,
  "finance_book": "finance_book_example",
  "service_items_total": 0,
  "total_value": 0,
  "target_incoming_rate": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "target_fixed_asset_account": "target_fixed_asset_account_example"
}
PATCH /api/assets/asset-capitalization/{id}

Update a asset capitalization

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

Body parameters

status string

Default: draft

title string
target_item_code string
target_asset string
target_asset_name string
company string
posting_date string
posting_time string
set_posting_time boolean

Default: false

stock_items_total number
asset_items_total number
finance_book string
service_items_total number
total_value number
target_incoming_rate number
cost_center string
project string
target_fixed_asset_account string

Returns

Returns the updated asset capitalization object.

PATCH /api/assets/asset-capitalization/{id} 
curl https://api.overplane.dev/api/assets/asset-capitalization/asset-capitalization_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","title":"title_example"}'
Response 
{
  "id": "asset-capitalization_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "target_item_code": "target_item_code_example",
  "target_asset": "target_asset_example",
  "target_asset_name": "target_asset_name_example",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "stock_items_total": 0,
  "asset_items_total": 0,
  "finance_book": "finance_book_example",
  "service_items_total": 0,
  "total_value": 0,
  "target_incoming_rate": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "target_fixed_asset_account": "target_fixed_asset_account_example"
}
DELETE /api/assets/asset-capitalization/{id}

Delete a asset capitalization

Permanently deletes a asset capitalization. This cannot be undone.

Path parameters

id string required

The identifier of the asset capitalization to delete.

Returns

Returns a confirmation that the asset capitalization has been deleted.

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

Submit a asset capitalization

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

Path parameters

id string required

The identifier of the asset capitalization to act on.

Returns

Returns the asset capitalization object with updated status.

POST /api/assets/asset-capitalization/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-capitalization/asset-capitalization_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-capitalization_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "target_item_code": "target_item_code_example",
  "target_asset": "target_asset_example",
  "target_asset_name": "target_asset_name_example",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "stock_items_total": 0,
  "asset_items_total": 0,
  "finance_book": "finance_book_example",
  "service_items_total": 0,
  "total_value": 0,
  "target_incoming_rate": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "target_fixed_asset_account": "target_fixed_asset_account_example"
}
POST /api/assets/asset-capitalization/{id}/cancel

Cancel a asset capitalization

Cancels a submitted asset capitalization, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the asset capitalization to act on.

Returns

Returns the asset capitalization object with updated status.

POST /api/assets/asset-capitalization/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-capitalization/asset-capitalization_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-capitalization_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "target_item_code": "target_item_code_example",
  "target_asset": "target_asset_example",
  "target_asset_name": "target_asset_name_example",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "stock_items_total": 0,
  "asset_items_total": 0,
  "finance_book": "finance_book_example",
  "service_items_total": 0,
  "total_value": 0,
  "target_incoming_rate": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "target_fixed_asset_account": "target_fixed_asset_account_example"
}

Line items

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

Asset Capitalization Asset Item

Attributes

idx integer
asset_capitalization_id string required
asset string required
asset_name string
item_code string required
item_name string
asset_value number
fixed_asset_account string
cost_center string
project string
finance_book string
current_asset_value number

Endpoints

GET /api/assets/asset-capitalization-asset-item?parent_id={id}
POST /api/assets/asset-capitalization-asset-item
PATCH /api/assets/asset-capitalization-asset-item/{id}
DELETE /api/assets/asset-capitalization-asset-item/{id}
POST /api/assets/asset-capitalization-asset-item/reorder
Asset Capitalization Asset Item object 
{
  "id": "asset-capitalization-asset-item_abc123",
  "idx": 1,
  "asset_capitalization_id": "asset_capitalization_id_example",
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "asset_value": 0,
  "fixed_asset_account": "fixed_asset_account_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "finance_book": "finance_book_example",
  "current_asset_value": 0
}

Asset Capitalization Service Item

Attributes

idx integer
asset_capitalization_id string required
item_code string
item_name string
expense_account string required
qty number
uom string
rate number
amount number
cost_center string

Endpoints

GET /api/assets/asset-capitalization-service-item?parent_id={id}
POST /api/assets/asset-capitalization-service-item
PATCH /api/assets/asset-capitalization-service-item/{id}
DELETE /api/assets/asset-capitalization-service-item/{id}
POST /api/assets/asset-capitalization-service-item/reorder
Asset Capitalization Service Item object 
{
  "id": "asset-capitalization-service-item_abc123",
  "idx": 1,
  "asset_capitalization_id": "asset_capitalization_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "expense_account": "expense_account_example",
  "qty": 1,
  "uom": "uom_example",
  "rate": 0,
  "amount": 0,
  "cost_center": "cost_center_example"
}

Asset Capitalization Stock Item

Attributes

idx integer
asset_capitalization_id string required
warehouse string required
batch_no string
stock_qty number
stock_uom string required
valuation_rate number
amount number
serial_no string
item_code string required
item_name string
actual_qty number
cost_center string
serial_and_batch_bundle string
use_serial_batch_fields boolean
purchase_receipt_item string

Endpoints

GET /api/assets/asset-capitalization-stock-item?parent_id={id}
POST /api/assets/asset-capitalization-stock-item
PATCH /api/assets/asset-capitalization-stock-item/{id}
DELETE /api/assets/asset-capitalization-stock-item/{id}
POST /api/assets/asset-capitalization-stock-item/reorder
Asset Capitalization Stock Item object 
{
  "id": "asset-capitalization-stock-item_abc123",
  "idx": 1,
  "asset_capitalization_id": "asset_capitalization_id_example",
  "warehouse": "warehouse_example",
  "batch_no": "batch_no_example",
  "stock_qty": 0,
  "stock_uom": "stock_uom_example",
  "valuation_rate": 0,
  "amount": 0,
  "serial_no": "serial_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "actual_qty": 0,
  "cost_center": "cost_center_example",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "use_serial_batch_fields": false,
  "purchase_receipt_item": "purchase_receipt_item_example"
}