The Asset Movement 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 required
purpose string required
transaction_date string required
reference_doctype string
reference_name string
The Asset Movement object 
{
  "id": "asset-movement_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "transaction_date": "2024-01-15",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example"
}
GET /api/assets/asset-movement/{id}

Retrieve a asset movement

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

Path parameters

id string required

The identifier of the asset movement to retrieve.

Returns

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

GET /api/assets/asset-movement/{id} 
curl https://api.overplane.dev/api/assets/asset-movement/asset-movement_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-movement_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "transaction_date": "2024-01-15",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example"
}
GET /api/assets/asset-movement

List all asset movements

Returns a list of asset movements. 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 movement objects.

GET /api/assets/asset-movement 
curl https://api.overplane.dev/api/assets/asset-movement \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-movement_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "purpose": "purpose_example",
      "transaction_date": "2024-01-15",
      "reference_doctype": "reference_doctype_example",
      "reference_name": "reference_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-movement

Create a asset movement

Creates a new asset movement object.

Body parameters

status string

Default: draft

company string required
purpose string required
transaction_date string required
reference_doctype string
reference_name string

Returns

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

POST /api/assets/asset-movement 
curl https://api.overplane.dev/api/assets/asset-movement \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","purpose":"purpose_example","transaction_date":"2024-01-15"}'
Response 
{
  "id": "asset-movement_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "transaction_date": "2024-01-15",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example"
}
PATCH /api/assets/asset-movement/{id}

Update a asset movement

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

Body parameters

status string

Default: draft

company string
purpose string
transaction_date string
reference_doctype string
reference_name string

Returns

Returns the updated asset movement object.

PATCH /api/assets/asset-movement/{id} 
curl https://api.overplane.dev/api/assets/asset-movement/asset-movement_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "asset-movement_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "transaction_date": "2024-01-15",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example"
}
DELETE /api/assets/asset-movement/{id}

Delete a asset movement

Permanently deletes a asset movement. This cannot be undone.

Path parameters

id string required

The identifier of the asset movement to delete.

Returns

Returns a confirmation that the asset movement has been deleted.

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

Submit a asset movement

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

Path parameters

id string required

The identifier of the asset movement to act on.

Returns

Returns the asset movement object with updated status.

POST /api/assets/asset-movement/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-movement/asset-movement_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-movement_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "transaction_date": "2024-01-15",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example"
}
POST /api/assets/asset-movement/{id}/cancel

Cancel a asset movement

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

Path parameters

id string required

The identifier of the asset movement to act on.

Returns

Returns the asset movement object with updated status.

POST /api/assets/asset-movement/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-movement/asset-movement_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-movement_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "purpose": "purpose_example",
  "transaction_date": "2024-01-15",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example"
}

Line items

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

Asset Movement Item

Attributes

idx integer
asset_movement_id string required
asset string required
asset_name string
source_location string
target_location string
from_employee string
to_employee string
company string

Endpoints

GET /api/assets/asset-movement-item?parent_id={id}
POST /api/assets/asset-movement-item
PATCH /api/assets/asset-movement-item/{id}
DELETE /api/assets/asset-movement-item/{id}
POST /api/assets/asset-movement-item/reorder
Asset Movement Item object 
{
  "id": "asset-movement-item_abc123",
  "idx": 1,
  "asset_movement_id": "asset_movement_id_example",
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "source_location": "source_location_example",
  "target_location": "target_location_example",
  "from_employee": "from_employee_example",
  "to_employee": "to_employee_example",
  "company": "Example Corp"
}