The Maintenance Schedule 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

customer string
transaction_date string required
customer_name string
contact_person string
contact_mobile string
contact_email string
contact_display string
customer_address string
address_display string
territory string
customer_group string
company string required
The Maintenance Schedule object 
{
  "id": "maintenance-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "transaction_date": "2024-01-15",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "contact_display": "contact_display_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "company": "Example Corp"
}
GET /api/maintenance/maintenance-schedule/{id}

Retrieve a maintenance schedule

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

Path parameters

id string required

The identifier of the maintenance schedule to retrieve.

Returns

Returns the maintenance schedule object if a valid identifier was provided.

GET /api/maintenance/maintenance-schedule/{id} 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule/maintenance-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "maintenance-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "transaction_date": "2024-01-15",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "contact_display": "contact_display_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "company": "Example Corp"
}
GET /api/maintenance/maintenance-schedule

List all maintenance schedules

Returns a list of maintenance schedules. 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 maintenance schedule objects.

GET /api/maintenance/maintenance-schedule 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "maintenance-schedule_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "customer": "customer_example",
      "transaction_date": "2024-01-15",
      "customer_name": "customer_name_example",
      "contact_person": "contact_person_example",
      "contact_mobile": "contact_mobile_example",
      "contact_email": "user@example.com",
      "contact_display": "contact_display_example",
      "customer_address": "customer_address_example",
      "address_display": "address_display_example",
      "territory": "territory_example",
      "customer_group": "customer_group_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/maintenance/maintenance-schedule

Create a maintenance schedule

Creates a new maintenance schedule object.

Body parameters

status string

Default: draft

customer string
transaction_date string required
customer_name string
contact_person string
contact_mobile string
contact_email string
contact_display string
customer_address string
address_display string
territory string
customer_group string
company string required

Returns

Returns the newly created maintenance schedule object if the call succeeded.

POST /api/maintenance/maintenance-schedule 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"transaction_date":"2024-01-15","company":"Example Corp"}'
Response 
{
  "id": "maintenance-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "transaction_date": "2024-01-15",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "contact_display": "contact_display_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "company": "Example Corp"
}
PATCH /api/maintenance/maintenance-schedule/{id}

Update a maintenance schedule

Updates the specified maintenance schedule 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 maintenance schedule to update.

Body parameters

status string

Default: draft

customer string
transaction_date string
customer_name string
contact_person string
contact_mobile string
contact_email string
contact_display string
customer_address string
address_display string
territory string
customer_group string
company string

Returns

Returns the updated maintenance schedule object.

PATCH /api/maintenance/maintenance-schedule/{id} 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule/maintenance-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","customer":"customer_example"}'
Response 
{
  "id": "maintenance-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "transaction_date": "2024-01-15",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "contact_display": "contact_display_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "company": "Example Corp"
}
DELETE /api/maintenance/maintenance-schedule/{id}

Delete a maintenance schedule

Permanently deletes a maintenance schedule. This cannot be undone.

Path parameters

id string required

The identifier of the maintenance schedule to delete.

Returns

Returns a confirmation that the maintenance schedule has been deleted.

DELETE /api/maintenance/maintenance-schedule/{id} 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule/maintenance-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "maintenance-schedule_abc123",
  "deleted": true
}
POST /api/maintenance/maintenance-schedule/{id}/submit

Submit a maintenance schedule

Submits a draft maintenance schedule, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the maintenance schedule to act on.

Returns

Returns the maintenance schedule object with updated status.

POST /api/maintenance/maintenance-schedule/{id}/submit 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule/maintenance-schedule_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "maintenance-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "transaction_date": "2024-01-15",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "contact_display": "contact_display_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "company": "Example Corp"
}
POST /api/maintenance/maintenance-schedule/{id}/cancel

Cancel a maintenance schedule

Cancels a submitted maintenance schedule, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the maintenance schedule to act on.

Returns

Returns the maintenance schedule object with updated status.

POST /api/maintenance/maintenance-schedule/{id}/cancel 
curl https://api.overplane.dev/api/maintenance/maintenance-schedule/maintenance-schedule_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "maintenance-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "transaction_date": "2024-01-15",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "contact_display": "contact_display_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "company": "Example Corp"
}

Line items

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

Maintenance Schedule Detail

Attributes

idx integer
maintenance_schedule_id string required
item_code string
item_name string
scheduled_date string required
actual_date string
sales_person string
serial_no string
completion_status string
item_reference string

Endpoints

GET /api/maintenance/maintenance-schedule-detail?parent_id={id}
POST /api/maintenance/maintenance-schedule-detail
PATCH /api/maintenance/maintenance-schedule-detail/{id}
DELETE /api/maintenance/maintenance-schedule-detail/{id}
POST /api/maintenance/maintenance-schedule-detail/reorder
Maintenance Schedule Detail object 
{
  "id": "maintenance-schedule-detail_abc123",
  "idx": 1,
  "maintenance_schedule_id": "maintenance_schedule_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "scheduled_date": "2024-01-15",
  "actual_date": "2024-01-15",
  "sales_person": "sales_person_example",
  "serial_no": "serial_no_example",
  "completion_status": "Pending",
  "item_reference": "item_reference_example"
}

Maintenance Schedule Item

Attributes

idx integer
maintenance_schedule_id string required
item_code string required
item_name string
description string
start_date string required
end_date string required
periodicity string
no_of_visits integer required
sales_person string
serial_no string
sales_order string
serial_and_batch_bundle string

Endpoints

GET /api/maintenance/maintenance-schedule-item?parent_id={id}
POST /api/maintenance/maintenance-schedule-item
PATCH /api/maintenance/maintenance-schedule-item/{id}
DELETE /api/maintenance/maintenance-schedule-item/{id}
POST /api/maintenance/maintenance-schedule-item/reorder
Maintenance Schedule Item object 
{
  "id": "maintenance-schedule-item_abc123",
  "idx": 1,
  "maintenance_schedule_id": "maintenance_schedule_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "periodicity": "periodicity_example",
  "no_of_visits": 0,
  "sales_person": "sales_person_example",
  "serial_no": "serial_no_example",
  "sales_order": "sales_order_example",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example"
}