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

failure_date string required
completion_date string
repair_status string

Default: Pending

description string
actions_performed string
downtime string
repair_cost number

Default: 0

asset string required
asset_name string
capitalize_repair_cost boolean

Default: false

cost_center string
project string
total_repair_cost number
increase_in_asset_life integer
company string
consumed_items_cost number
The Asset Repair object 
{
  "id": "asset-repair_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "failure_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "repair_status": "Pending",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "downtime": "downtime_example",
  "repair_cost": 0,
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "capitalize_repair_cost": false,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "total_repair_cost": 0,
  "increase_in_asset_life": 0,
  "company": "Example Corp",
  "consumed_items_cost": 0
}
GET /api/assets/asset-repair/{id}

Retrieve a asset repair

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

Path parameters

id string required

The identifier of the asset repair to retrieve.

Returns

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

GET /api/assets/asset-repair/{id} 
curl https://api.overplane.dev/api/assets/asset-repair/asset-repair_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-repair_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "failure_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "repair_status": "Pending",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "downtime": "downtime_example",
  "repair_cost": 0,
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "capitalize_repair_cost": false,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "total_repair_cost": 0,
  "increase_in_asset_life": 0,
  "company": "Example Corp",
  "consumed_items_cost": 0
}
GET /api/assets/asset-repair

List all asset repairs

Returns a list of asset repairs. 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 repair objects.

GET /api/assets/asset-repair 
curl https://api.overplane.dev/api/assets/asset-repair \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-repair_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "failure_date": "2024-01-15",
      "completion_date": "2024-01-15",
      "repair_status": "Pending",
      "description": "description_example",
      "actions_performed": "actions_performed_example",
      "downtime": "downtime_example",
      "repair_cost": 0,
      "asset": "asset_example",
      "asset_name": "asset_name_example",
      "capitalize_repair_cost": false,
      "cost_center": "cost_center_example",
      "project": "project_example",
      "total_repair_cost": 0,
      "increase_in_asset_life": 0,
      "company": "Example Corp",
      "consumed_items_cost": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-repair

Create a asset repair

Creates a new asset repair object.

Body parameters

status string

Default: draft

failure_date string required
completion_date string
repair_status string

Default: Pending

description string
actions_performed string
downtime string
repair_cost number

Default: 0

asset string required
asset_name string
capitalize_repair_cost boolean

Default: false

cost_center string
project string
total_repair_cost number
increase_in_asset_life integer
company string
consumed_items_cost number

Returns

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

POST /api/assets/asset-repair 
curl https://api.overplane.dev/api/assets/asset-repair \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"failure_date":"2024-01-15","asset":"asset_example"}'
Response 
{
  "id": "asset-repair_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "failure_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "repair_status": "Pending",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "downtime": "downtime_example",
  "repair_cost": 0,
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "capitalize_repair_cost": false,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "total_repair_cost": 0,
  "increase_in_asset_life": 0,
  "company": "Example Corp",
  "consumed_items_cost": 0
}
PATCH /api/assets/asset-repair/{id}

Update a asset repair

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

Body parameters

status string

Default: draft

failure_date string
completion_date string
repair_status string

Default: Pending

description string
actions_performed string
downtime string
repair_cost number

Default: 0

asset string
asset_name string
capitalize_repair_cost boolean

Default: false

cost_center string
project string
total_repair_cost number
increase_in_asset_life integer
company string
consumed_items_cost number

Returns

Returns the updated asset repair object.

PATCH /api/assets/asset-repair/{id} 
curl https://api.overplane.dev/api/assets/asset-repair/asset-repair_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","failure_date":"2024-01-15"}'
Response 
{
  "id": "asset-repair_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "failure_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "repair_status": "Pending",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "downtime": "downtime_example",
  "repair_cost": 0,
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "capitalize_repair_cost": false,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "total_repair_cost": 0,
  "increase_in_asset_life": 0,
  "company": "Example Corp",
  "consumed_items_cost": 0
}
DELETE /api/assets/asset-repair/{id}

Delete a asset repair

Permanently deletes a asset repair. This cannot be undone.

Path parameters

id string required

The identifier of the asset repair to delete.

Returns

Returns a confirmation that the asset repair has been deleted.

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

Submit a asset repair

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

Path parameters

id string required

The identifier of the asset repair to act on.

Returns

Returns the asset repair object with updated status.

POST /api/assets/asset-repair/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-repair/asset-repair_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-repair_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "failure_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "repair_status": "Pending",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "downtime": "downtime_example",
  "repair_cost": 0,
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "capitalize_repair_cost": false,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "total_repair_cost": 0,
  "increase_in_asset_life": 0,
  "company": "Example Corp",
  "consumed_items_cost": 0
}
POST /api/assets/asset-repair/{id}/cancel

Cancel a asset repair

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

Path parameters

id string required

The identifier of the asset repair to act on.

Returns

Returns the asset repair object with updated status.

POST /api/assets/asset-repair/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-repair/asset-repair_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-repair_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "failure_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "repair_status": "Pending",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "downtime": "downtime_example",
  "repair_cost": 0,
  "asset": "asset_example",
  "asset_name": "asset_name_example",
  "capitalize_repair_cost": false,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "total_repair_cost": 0,
  "increase_in_asset_life": 0,
  "company": "Example Corp",
  "consumed_items_cost": 0
}

Line items

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

Asset Repair Consumed Item

Attributes

idx integer
asset_repair_id string required
valuation_rate number
consumed_quantity string
total_value number
serial_no string
item_code string required
serial_and_batch_bundle string
warehouse string required

Endpoints

GET /api/assets/asset-repair-consumed-item?parent_id={id}
POST /api/assets/asset-repair-consumed-item
PATCH /api/assets/asset-repair-consumed-item/{id}
DELETE /api/assets/asset-repair-consumed-item/{id}
POST /api/assets/asset-repair-consumed-item/reorder
Asset Repair Consumed Item object 
{
  "id": "asset-repair-consumed-item_abc123",
  "idx": 1,
  "asset_repair_id": "asset_repair_id_example",
  "valuation_rate": 0,
  "consumed_quantity": "consumed_quantity_example",
  "total_value": 0,
  "serial_no": "serial_no_example",
  "item_code": "item_code_example",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "warehouse": "warehouse_example"
}

Asset Repair Purchase Invoice

Attributes

idx integer
asset_repair_id string required
purchase_invoice string
expense_account string required
repair_cost number required

Endpoints

GET /api/assets/asset-repair-purchase-invoice?parent_id={id}
POST /api/assets/asset-repair-purchase-invoice
PATCH /api/assets/asset-repair-purchase-invoice/{id}
DELETE /api/assets/asset-repair-purchase-invoice/{id}
POST /api/assets/asset-repair-purchase-invoice/reorder
Asset Repair Purchase Invoice object 
{
  "id": "asset-repair-purchase-invoice_abc123",
  "idx": 1,
  "asset_repair_id": "asset_repair_id_example",
  "purchase_invoice": "purchase_invoice_example",
  "expense_account": "expense_account_example",
  "repair_cost": 0
}