GET v1/BomMasters?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of BOM Masters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

A comma-separated list of field names

string

None.

where

A where clause

string

None.

order

An order by clause

string

None.

page

The page number (default: 1)

integer

Default value is 1

rows

Rows per page (default: 50, maximum: 250)

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of BomMaster
NameDescriptionTypeAdditional information
Id

A unique Job ID.

integer

None.

CreatedDate

Created date time.

date

None.

ModifiedDate

Last modified date time.

date

None.

CreatedBy

Created by User ID.

integer

None.

ModifiedBy

Modified by User ID.

integer

None.

ProductionNotes

Production Notes.

string

None.

Reference

The unique Job reference.

string

Max length: 20

Product

Bom

BomProduct

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 99,
    "createdDate": "2020-10-20T02:20:46.625197Z",
    "modifiedDate": "2020-10-20T02:20:46.625197Z",
    "createdBy": 10,
    "modifiedBy": 0,
    "productionNotes": "Test Job",
    "reference": null,
    "product": {
      "id": 0,
      "productId": 0,
      "productOptionId": 0,
      "type": "Make",
      "sort": 0,
      "code": "TestProduct1",
      "name": "Composite Product",
      "option1": null,
      "option2": null,
      "option3": null,
      "notes": null,
      "qty": 1.0,
      "unitCost": 100.0,
      "components": [
        {
          "id": 0,
          "productId": 0,
          "productOptionId": 0,
          "type": "Use",
          "sort": 0,
          "code": "C1",
          "name": "Component 1",
          "option1": null,
          "option2": null,
          "option3": null,
          "notes": null,
          "qty": 1.0,
          "unitCost": 50.0
        }
      ]
    }
  }
]