The Subcontracting BOM 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.

is_active boolean

Default: true

finished_good string required
finished_good_qty number

Default: 1

finished_good_bom string required
service_item string required
service_item_qty number

Default: 1

service_item_uom string required
conversion_factor number
finished_good_uom string
The Subcontracting BOM object 
{
  "id": "subcontracting-b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "is_active": true,
  "finished_good": "finished_good_example",
  "finished_good_qty": 1,
  "finished_good_bom": "finished_good_bom_example",
  "service_item": "service_item_example",
  "service_item_qty": 1,
  "service_item_uom": "service_item_uom_example",
  "conversion_factor": 0,
  "finished_good_uom": "finished_good_uom_example"
}
GET /api/subcontracting/subcontracting-b-o-m/{id}

Retrieve a subcontracting bom

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

Path parameters

id string required

The identifier of the subcontracting bom to retrieve.

Returns

Returns the subcontracting bom object if a valid identifier was provided.

GET /api/subcontracting/subcontracting-b-o-m/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-b-o-m/subcontracting-b-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "subcontracting-b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "is_active": true,
  "finished_good": "finished_good_example",
  "finished_good_qty": 1,
  "finished_good_bom": "finished_good_bom_example",
  "service_item": "service_item_example",
  "service_item_qty": 1,
  "service_item_uom": "service_item_uom_example",
  "conversion_factor": 0,
  "finished_good_uom": "finished_good_uom_example"
}
GET /api/subcontracting/subcontracting-b-o-m

List all subcontracting boms

Returns a list of subcontracting boms. 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 subcontracting bom objects.

GET /api/subcontracting/subcontracting-b-o-m 
curl https://api.overplane.dev/api/subcontracting/subcontracting-b-o-m \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "subcontracting-b-o-m_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "is_active": true,
      "finished_good": "finished_good_example",
      "finished_good_qty": 1,
      "finished_good_bom": "finished_good_bom_example",
      "service_item": "service_item_example",
      "service_item_qty": 1,
      "service_item_uom": "service_item_uom_example",
      "conversion_factor": 0,
      "finished_good_uom": "finished_good_uom_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/subcontracting/subcontracting-b-o-m

Create a subcontracting bom

Creates a new subcontracting bom object.

Body parameters

is_active boolean

Default: true

finished_good string required
finished_good_qty number

Default: 1

finished_good_bom string required
service_item string required
service_item_qty number

Default: 1

service_item_uom string required
conversion_factor number
finished_good_uom string

Returns

Returns the newly created subcontracting bom object if the call succeeded.

POST /api/subcontracting/subcontracting-b-o-m 
curl https://api.overplane.dev/api/subcontracting/subcontracting-b-o-m \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"finished_good":"finished_good_example","finished_good_bom":"finished_good_bom_example","service_item":"service_item_example","service_item_uom":"service_item_uom_example"}'
Response 
{
  "id": "subcontracting-b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "is_active": true,
  "finished_good": "finished_good_example",
  "finished_good_qty": 1,
  "finished_good_bom": "finished_good_bom_example",
  "service_item": "service_item_example",
  "service_item_qty": 1,
  "service_item_uom": "service_item_uom_example",
  "conversion_factor": 0,
  "finished_good_uom": "finished_good_uom_example"
}
PATCH /api/subcontracting/subcontracting-b-o-m/{id}

Update a subcontracting bom

Updates the specified subcontracting bom 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 subcontracting bom to update.

Body parameters

is_active boolean

Default: true

finished_good string
finished_good_qty number

Default: 1

finished_good_bom string
service_item string
service_item_qty number

Default: 1

service_item_uom string
conversion_factor number
finished_good_uom string

Returns

Returns the updated subcontracting bom object.

PATCH /api/subcontracting/subcontracting-b-o-m/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-b-o-m/subcontracting-b-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"is_active":true,"finished_good":"finished_good_example"}'
Response 
{
  "id": "subcontracting-b-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "is_active": true,
  "finished_good": "finished_good_example",
  "finished_good_qty": 1,
  "finished_good_bom": "finished_good_bom_example",
  "service_item": "service_item_example",
  "service_item_qty": 1,
  "service_item_uom": "service_item_uom_example",
  "conversion_factor": 0,
  "finished_good_uom": "finished_good_uom_example"
}
DELETE /api/subcontracting/subcontracting-b-o-m/{id}

Delete a subcontracting bom

Permanently deletes a subcontracting bom. This cannot be undone.

Path parameters

id string required

The identifier of the subcontracting bom to delete.

Returns

Returns a confirmation that the subcontracting bom has been deleted.

DELETE /api/subcontracting/subcontracting-b-o-m/{id} 
curl https://api.overplane.dev/api/subcontracting/subcontracting-b-o-m/subcontracting-b-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "subcontracting-b-o-m_abc123",
  "deleted": true
}