The Asset Shift Allocation 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
The Asset Shift Allocation object 
{
  "id": "asset-shift-allocation_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"
}
GET /api/assets/asset-shift-allocation/{id}

Retrieve a asset shift allocation

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

Path parameters

id string required

The identifier of the asset shift allocation to retrieve.

Returns

Returns the asset shift allocation object if a valid identifier was provided.

GET /api/assets/asset-shift-allocation/{id} 
curl https://api.overplane.dev/api/assets/asset-shift-allocation/asset-shift-allocation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-shift-allocation_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"
}
GET /api/assets/asset-shift-allocation

List all asset shift allocations

Returns a list of asset shift allocations. 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 shift allocation objects.

GET /api/assets/asset-shift-allocation 
curl https://api.overplane.dev/api/assets/asset-shift-allocation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-shift-allocation_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"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-shift-allocation

Create a asset shift allocation

Creates a new asset shift allocation object.

Body parameters

status string

Default: draft

asset string required
finance_book string

Returns

Returns the newly created asset shift allocation object if the call succeeded.

POST /api/assets/asset-shift-allocation 
curl https://api.overplane.dev/api/assets/asset-shift-allocation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"asset":"asset_example"}'
Response 
{
  "id": "asset-shift-allocation_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"
}
PATCH /api/assets/asset-shift-allocation/{id}

Update a asset shift allocation

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

Body parameters

status string

Default: draft

asset string
finance_book string

Returns

Returns the updated asset shift allocation object.

PATCH /api/assets/asset-shift-allocation/{id} 
curl https://api.overplane.dev/api/assets/asset-shift-allocation/asset-shift-allocation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","asset":"asset_example"}'
Response 
{
  "id": "asset-shift-allocation_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"
}
DELETE /api/assets/asset-shift-allocation/{id}

Delete a asset shift allocation

Permanently deletes a asset shift allocation. This cannot be undone.

Path parameters

id string required

The identifier of the asset shift allocation to delete.

Returns

Returns a confirmation that the asset shift allocation has been deleted.

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

Submit a asset shift allocation

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

Path parameters

id string required

The identifier of the asset shift allocation to act on.

Returns

Returns the asset shift allocation object with updated status.

POST /api/assets/asset-shift-allocation/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-shift-allocation/asset-shift-allocation_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-shift-allocation_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"
}
POST /api/assets/asset-shift-allocation/{id}/cancel

Cancel a asset shift allocation

Cancels a submitted asset shift allocation, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the asset shift allocation to act on.

Returns

Returns the asset shift allocation object with updated status.

POST /api/assets/asset-shift-allocation/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-shift-allocation/asset-shift-allocation_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-shift-allocation_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"
}