The Asset Value Adjustment 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

company string
asset string required
asset_category string
finance_book string
journal_entry string
date string required
current_asset_value number required
new_asset_value number required
difference_amount number
cost_center string
difference_account string required
The Asset Value Adjustment object 
{
  "id": "asset-value-adjustment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "asset": "asset_example",
  "asset_category": "asset_category_example",
  "finance_book": "finance_book_example",
  "journal_entry": "journal_entry_example",
  "date": "2024-01-15",
  "current_asset_value": 0,
  "new_asset_value": 0,
  "difference_amount": 0,
  "cost_center": "cost_center_example",
  "difference_account": "difference_account_example"
}
GET /api/assets/asset-value-adjustment/{id}

Retrieve a asset value adjustment

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

Path parameters

id string required

The identifier of the asset value adjustment to retrieve.

Returns

Returns the asset value adjustment object if a valid identifier was provided.

GET /api/assets/asset-value-adjustment/{id} 
curl https://api.overplane.dev/api/assets/asset-value-adjustment/asset-value-adjustment_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-value-adjustment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "asset": "asset_example",
  "asset_category": "asset_category_example",
  "finance_book": "finance_book_example",
  "journal_entry": "journal_entry_example",
  "date": "2024-01-15",
  "current_asset_value": 0,
  "new_asset_value": 0,
  "difference_amount": 0,
  "cost_center": "cost_center_example",
  "difference_account": "difference_account_example"
}
GET /api/assets/asset-value-adjustment

List all asset value adjustments

Returns a list of asset value adjustments. 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 value adjustment objects.

GET /api/assets/asset-value-adjustment 
curl https://api.overplane.dev/api/assets/asset-value-adjustment \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-value-adjustment_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "asset": "asset_example",
      "asset_category": "asset_category_example",
      "finance_book": "finance_book_example",
      "journal_entry": "journal_entry_example",
      "date": "2024-01-15",
      "current_asset_value": 0,
      "new_asset_value": 0,
      "difference_amount": 0,
      "cost_center": "cost_center_example",
      "difference_account": "difference_account_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-value-adjustment

Create a asset value adjustment

Creates a new asset value adjustment object.

Body parameters

status string

Default: draft

company string
asset string required
asset_category string
finance_book string
journal_entry string
date string required
current_asset_value number required
new_asset_value number required
difference_amount number
cost_center string
difference_account string required

Returns

Returns the newly created asset value adjustment object if the call succeeded.

POST /api/assets/asset-value-adjustment 
curl https://api.overplane.dev/api/assets/asset-value-adjustment \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"asset":"asset_example","date":"2024-01-15","current_asset_value":0,"new_asset_value":0,"difference_account":"difference_account_example"}'
Response 
{
  "id": "asset-value-adjustment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "asset": "asset_example",
  "asset_category": "asset_category_example",
  "finance_book": "finance_book_example",
  "journal_entry": "journal_entry_example",
  "date": "2024-01-15",
  "current_asset_value": 0,
  "new_asset_value": 0,
  "difference_amount": 0,
  "cost_center": "cost_center_example",
  "difference_account": "difference_account_example"
}
PATCH /api/assets/asset-value-adjustment/{id}

Update a asset value adjustment

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

Body parameters

status string

Default: draft

company string
asset string
asset_category string
finance_book string
journal_entry string
date string
current_asset_value number
new_asset_value number
difference_amount number
cost_center string
difference_account string

Returns

Returns the updated asset value adjustment object.

PATCH /api/assets/asset-value-adjustment/{id} 
curl https://api.overplane.dev/api/assets/asset-value-adjustment/asset-value-adjustment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "asset-value-adjustment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "asset": "asset_example",
  "asset_category": "asset_category_example",
  "finance_book": "finance_book_example",
  "journal_entry": "journal_entry_example",
  "date": "2024-01-15",
  "current_asset_value": 0,
  "new_asset_value": 0,
  "difference_amount": 0,
  "cost_center": "cost_center_example",
  "difference_account": "difference_account_example"
}
DELETE /api/assets/asset-value-adjustment/{id}

Delete a asset value adjustment

Permanently deletes a asset value adjustment. This cannot be undone.

Path parameters

id string required

The identifier of the asset value adjustment to delete.

Returns

Returns a confirmation that the asset value adjustment has been deleted.

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

Submit a asset value adjustment

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

Path parameters

id string required

The identifier of the asset value adjustment to act on.

Returns

Returns the asset value adjustment object with updated status.

POST /api/assets/asset-value-adjustment/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-value-adjustment/asset-value-adjustment_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-value-adjustment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "asset": "asset_example",
  "asset_category": "asset_category_example",
  "finance_book": "finance_book_example",
  "journal_entry": "journal_entry_example",
  "date": "2024-01-15",
  "current_asset_value": 0,
  "new_asset_value": 0,
  "difference_amount": 0,
  "cost_center": "cost_center_example",
  "difference_account": "difference_account_example"
}
POST /api/assets/asset-value-adjustment/{id}/cancel

Cancel a asset value adjustment

Cancels a submitted asset value adjustment, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the asset value adjustment to act on.

Returns

Returns the asset value adjustment object with updated status.

POST /api/assets/asset-value-adjustment/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-value-adjustment/asset-value-adjustment_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-value-adjustment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "asset": "asset_example",
  "asset_category": "asset_category_example",
  "finance_book": "finance_book_example",
  "journal_entry": "journal_entry_example",
  "date": "2024-01-15",
  "current_asset_value": 0,
  "new_asset_value": 0,
  "difference_amount": 0,
  "cost_center": "cost_center_example",
  "difference_account": "difference_account_example"
}