The Installation Note 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 required
customer_address string
contact_person string
customer_name string
address_display string
contact_display string
contact_mobile string
contact_email string
territory string required
customer_group string
inst_date string required
inst_time string
company string required
remarks string
project string
The Installation Note object 
{
  "id": "installation-note_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "customer_name": "customer_name_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "[email protected]",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "inst_date": "2024-01-15",
  "inst_time": "inst_time_example",
  "company": "Example Corp",
  "remarks": "remarks_example",
  "project": "project_example"
}
GET /api/stock/installation-note/{id}

Retrieve a installation note

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

Path parameters

id string required

The identifier of the installation note to retrieve.

Returns

Returns the installation note object if a valid identifier was provided.

GET /api/stock/installation-note/{id} 
curl https://api.overplane.dev/api/stock/installation-note/installation-note_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "installation-note_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "customer_name": "customer_name_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "[email protected]",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "inst_date": "2024-01-15",
  "inst_time": "inst_time_example",
  "company": "Example Corp",
  "remarks": "remarks_example",
  "project": "project_example"
}
GET /api/stock/installation-note

List all installation notes

Returns a list of installation notes. 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 installation note objects.

GET /api/stock/installation-note 
curl https://api.overplane.dev/api/stock/installation-note \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "installation-note_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "customer": "customer_example",
      "customer_address": "customer_address_example",
      "contact_person": "contact_person_example",
      "customer_name": "customer_name_example",
      "address_display": "address_display_example",
      "contact_display": "contact_display_example",
      "contact_mobile": "contact_mobile_example",
      "contact_email": "[email protected]",
      "territory": "territory_example",
      "customer_group": "customer_group_example",
      "inst_date": "2024-01-15",
      "inst_time": "inst_time_example",
      "company": "Example Corp",
      "remarks": "remarks_example",
      "project": "project_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/installation-note

Create a installation note

Creates a new installation note object.

Body parameters

status string

Default: draft

customer string required
customer_address string
contact_person string
customer_name string
address_display string
contact_display string
contact_mobile string
contact_email string
territory string required
customer_group string
inst_date string required
inst_time string
company string required
remarks string
project string

Returns

Returns the newly created installation note object if the call succeeded.

POST /api/stock/installation-note 
curl https://api.overplane.dev/api/stock/installation-note \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"customer":"customer_example","territory":"territory_example","inst_date":"2024-01-15","company":"Example Corp"}'
Response 
{
  "id": "installation-note_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "customer_name": "customer_name_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "[email protected]",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "inst_date": "2024-01-15",
  "inst_time": "inst_time_example",
  "company": "Example Corp",
  "remarks": "remarks_example",
  "project": "project_example"
}
PATCH /api/stock/installation-note/{id}

Update a installation note

Updates the specified installation note 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 installation note to update.

Body parameters

status string

Default: draft

customer string
customer_address string
contact_person string
customer_name string
address_display string
contact_display string
contact_mobile string
contact_email string
territory string
customer_group string
inst_date string
inst_time string
company string
remarks string
project string

Returns

Returns the updated installation note object.

PATCH /api/stock/installation-note/{id} 
curl https://api.overplane.dev/api/stock/installation-note/installation-note_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","customer":"customer_example"}'
Response 
{
  "id": "installation-note_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "customer_name": "customer_name_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "[email protected]",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "inst_date": "2024-01-15",
  "inst_time": "inst_time_example",
  "company": "Example Corp",
  "remarks": "remarks_example",
  "project": "project_example"
}
DELETE /api/stock/installation-note/{id}

Delete a installation note

Permanently deletes a installation note. This cannot be undone.

Path parameters

id string required

The identifier of the installation note to delete.

Returns

Returns a confirmation that the installation note has been deleted.

DELETE /api/stock/installation-note/{id} 
curl https://api.overplane.dev/api/stock/installation-note/installation-note_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "installation-note_abc123",
  "deleted": true
}
POST /api/stock/installation-note/{id}/submit

Submit a installation note

Submits a draft installation note, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the installation note to act on.

Returns

Returns the installation note object with updated status.

POST /api/stock/installation-note/{id}/submit 
curl https://api.overplane.dev/api/stock/installation-note/installation-note_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "installation-note_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "customer_name": "customer_name_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "[email protected]",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "inst_date": "2024-01-15",
  "inst_time": "inst_time_example",
  "company": "Example Corp",
  "remarks": "remarks_example",
  "project": "project_example"
}
POST /api/stock/installation-note/{id}/cancel

Cancel a installation note

Cancels a submitted installation note, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the installation note to act on.

Returns

Returns the installation note object with updated status.

POST /api/stock/installation-note/{id}/cancel 
curl https://api.overplane.dev/api/stock/installation-note/installation-note_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "installation-note_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "customer": "customer_example",
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "customer_name": "customer_name_example",
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "[email protected]",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "inst_date": "2024-01-15",
  "inst_time": "inst_time_example",
  "company": "Example Corp",
  "remarks": "remarks_example",
  "project": "project_example"
}

Line items

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

Installation Note Item

Attributes

idx integer
installation_note_id string required
item_code string required
serial_no string
qty number required
description string
prevdoc_detail_docname string
prevdoc_docname string
prevdoc_doctype string
serial_and_batch_bundle string

Endpoints

GET /api/stock/installation-note-item?parent_id={id}
POST /api/stock/installation-note-item
PATCH /api/stock/installation-note-item/{id}
DELETE /api/stock/installation-note-item/{id}
POST /api/stock/installation-note-item/reorder
Installation Note Item object 
{
  "id": "installation-note-item_abc123",
  "idx": 1,
  "installation_note_id": "installation_note_id_example",
  "item_code": "item_code_example",
  "serial_no": "serial_no_example",
  "qty": 0,
  "description": "description_example",
  "prevdoc_detail_docname": "prevdoc_detail_docname_example",
  "prevdoc_docname": "prevdoc_docname_example",
  "prevdoc_doctype": "prevdoc_doctype_example",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example"
}