openapi: 3.2.0
info:
title: Eci Solutions View API
version: 3.5.585+b1e45fd230
contact:
name: ECI Manufacturing Division Integration Team
url: https://www.ecisolutions.com/support/
description: 'Operations tagged View across 3 of this provider''s published API definitions: eci-solutions-erp-v1-openapi.json, eci-solutions-erp-v2-1-openapi.json, eci-solutions-erp-v2-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
security:
- Bearer: []
tags:
- name: View
paths:
/api/v1/view/Departments:
get:
tags:
- View
summary: Gets a list of Department
description: 'Gets a list of Department.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
deptID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_Departments
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
deptID[eq]: abc123
shortDesc[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Department'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Department'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/Employees:
get:
tags:
- View
summary: Gets a list of Employee
description: 'Gets a list of Employee.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
employeeID|Yes|Yes|Macola, M1, JobBOSS², Deacom
firstName|Yes|Yes|Macola, M1, JobBOSS², Deacom
lastName|Yes|Yes|Macola, M1, JobBOSS², Deacom
title|Yes|Yes|Macola, M1, JobBOSS², Deacom
supervisorEmployeeID|Yes|Yes|Macola, M1, JobBOSS², Deacom
payRate|Yes|Yes|Macola, M1, JobBOSS², Deacom
deptID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shiftID|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_Employees
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
employeeID[eq]: abc123
firstName[eq]: abc123
lastName[eq]: abc123
title[eq]: abc123
supervisorEmployeeID[gte]: 123
payRate[gte]: 123
deptID[eq]: abc123
shiftID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Employee'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Employee'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/JobOperations:
get:
tags:
- View
summary: Gets a list of JobOperation
description: 'Gets a list of JobOperation.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|Macola, M1, JobBOSS², Deacom
jobAssembly|Yes|Yes|Macola, M1, JobBOSS², Deacom
jobOperationSeq|Yes|Yes|Macola, M1, JobBOSS², Deacom
status|Yes|Yes|Macola, M1, JobBOSS², Deacom
workCenterID|Yes|Yes|Macola, M1, JobBOSS², Deacom
processID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
longDescText|Yes|Yes|Macola, M1, JobBOSS², Deacom
longDescFormatted|No|Yes|Macola, M1, JobBOSS², Deacom
outsideOperation|Yes|Yes|Macola, M1, JobBOSS², Deacom
partID|Yes|Yes|Macola, M1, JobBOSS², Deacom
partRevisionID|Yes|Yes|Macola, M1, JobBOSS², Deacom
schedStartDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
schedEndDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
actStartDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
actEndDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
estSetupHours|No|Yes|Macola, M1, JobBOSS², Deacom
estProdHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estQueueHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estMoveHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estQAHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
actSetupHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
actualProdHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
actQAHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
vendorID|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_JobOperations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssembly[eq]: abc123
jobOperationSeq[gte]: 123
status[eq]: abc123
workCenterID[eq]: abc123
processID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
outsideOperation[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
schedStartDate[gte]: '2020-09-25T04:03:00.0000000'
schedEndDate[gte]: '2020-09-25T04:03:00.0000000'
actStartDate[gte]: '2020-09-25T04:03:00.0000000'
actEndDate[gte]: '2020-09-25T04:03:00.0000000'
estProdHours[gte]: 123
estQueueHours[gte]: 123
estMoveHours[gte]: 123
estQAHours[gte]: 123
actSetupHours[gte]: 123
actualProdHours[gte]: 123
actQAHours[gte]: 123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobOperation'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobOperation'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/jobs:
get:
tags:
- View
summary: Gets a list of Job
description: 'Gets a list of Job.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|Macola, M1, JobBOSS², Deacom
customerID|No|Yes|Macola, M1, JobBOSS², Deacom
partID|No|Yes|Macola, M1, JobBOSS², Deacom
partRevisionID|No|Yes|Macola, M1, JobBOSS², Deacom
orderQty|No|Yes|Macola, M1, JobBOSS², Deacom
prodQty|No|Yes|Macola, M1, JobBOSS², Deacom
schedStartDate|No|Yes|Macola, M1, JobBOSS², Deacom
schedEndDate|No|Yes|Macola, M1, JobBOSS², Deacom
estLeadTime|No|Yes|Macola, M1, JobBOSS², Deacom
actStartDate|No|Yes|Macola, M1, JobBOSS², Deacom
actEndDate|No|Yes|Macola, M1, JobBOSS², Deacom
dueDate|No|Yes|Macola, M1, JobBOSS², Deacom
status|No|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom
parentJobID|No|Yes|JobBOSS²'
operationId: GET__api_v1_view_jobs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
jobOperations|JobOperations[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Job'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Job'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/PartOperations:
get:
tags:
- View
summary: Gets a list of PartOperation
description: 'Gets a list of PartOperation.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|Macola, M1, JobBOSS², Deacom
partRevisionID|Yes|Yes|Macola, M1, JobBOSS², Deacom
partOperationSeq|Yes|Yes|Macola, M1, JobBOSS², Deacom
workCenterID|Yes|Yes|Macola, M1, JobBOSS², Deacom
processID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
longDescText|Yes|Yes|Macola, M1, JobBOSS², Deacom
longDescFormatted|Yes|Yes|Macola, M1, JobBOSS², Deacom
outsideOperation|Yes|Yes|Macola, M1, JobBOSS², Deacom
estSetupHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estProdHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estQueueHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estMoveHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
estQAHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
vendorID|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_PartOperations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
partOperationSeq[gte]: 123
workCenterID[eq]: abc123
processID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
longDescFormatted[eq]: abc123
outsideOperation[eq]: abc123
estSetupHours[gte]: 123
estProdHours[gte]: 123
estQueueHours[gte]: 123
estMoveHours[gte]: 123
estQAHours[gte]: 123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartOperation'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartOperation'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/PartRevisions:
get:
tags:
- View
summary: Gets a list of PartRevision
description: 'Gets a list of PartRevision.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|Macola, M1, JobBOSS², Deacom
partRevisionID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
longDescText|Yes|Yes|Macola, M1, JobBOSS², Deacom
longDescFormatted|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_PartRevisions
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
longDescFormatted[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/Processes:
get:
tags:
- View
summary: Gets a list of Process
description: 'Gets a list of Process.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
processID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
setupRate|Yes|Yes|Macola, M1, JobBOSS², Deacom
productionRate|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_Processes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
processID[eq]: abc123
shortDesc[eq]: abc123
setupRate[eq]: abc123
productionRate[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Process'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Process'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/ProductionCalendars:
get:
tags:
- View
summary: Gets a list of ProductionCalendar
description: 'Gets a list of ProductionCalendar.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
productionDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
productionHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
productionStartTime|Yes|Yes|Macola, M1, JobBOSS², Deacom
workCenterID|Yes|Yes|Macola, M1, JobBOSS², Deacom
plantID|Yes|Yes|Macola, M1, JobBOSS², Deacom
department|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_ProductionCalendars
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
productionDate[gte]: '2020-09-25T04:03:00.0000000'
productionHours[gte]: 123
productionStartTime[eq]: abc123
workCenterID[eq]: abc123
plantID[eq]: abc123
department[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductionCalendar'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductionCalendar'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/SalesOrderDeliveries:
get:
tags:
- View
summary: Gets a list of SalesOrderDelivery
description: 'Gets a list of SalesOrderDelivery.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|Macola, M1, JobBOSS², Deacom
orderLine|Yes|Yes|Macola, M1, JobBOSS², Deacom
orderLineDelivery|Yes|Yes|Macola, M1, JobBOSS², Deacom
promisedDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
promisedQty|Yes|Yes|Macola, M1, JobBOSS², Deacom
shippedDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
shippedQty|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_SalesOrderDeliveries
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
orderLineDelivery[eq]: abc123
promisedDate[gte]: '2020-09-25T04:03:00.0000000'
promisedQty[gte]: 123
shippedDate[gte]: '2020-09-25T04:03:00.0000000'
shippedQty[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrderJobs|SalesOrderJobs[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/SalesOrderJobs:
get:
tags:
- View
summary: Gets a list of SalesOrderJob
description: 'Gets a list of SalesOrderJob.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|Macola, M1, JobBOSS², Deacom
orderLine|Yes|Yes|Macola, M1, JobBOSS², Deacom
orderLineDelivery|Yes|Yes|Macola, M1, JobBOSS², Deacom
jobID|Yes|Yes|Macola, M1, JobBOSS², Deacom
orderJobSeq|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_SalesOrderJobs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
orderLineDelivery[eq]: abc123
jobID[eq]: abc123
orderJobSeq[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/SalesOrderLines:
get:
tags:
- View
summary: Gets a list of SalesOrderLine
description: 'Gets a list of SalesOrderLine.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|Macola, M1, JobBOSS², Deacom
orderLine|Yes|Yes|Macola, M1, JobBOSS², Deacom
totalSalePrice|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_SalesOrderLines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
totalSalePrice[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrderDeliveries|SalesOrderDeliveries[]|
salesOrderJobs|SalesOrderJobs|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/ShiftDays:
get:
tags:
- View
summary: Gets a list of ShiftDay
description: 'Gets a list of ShiftDay.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
shiftID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shiftDay|Yes|Yes|Macola, M1, JobBOSS², Deacom
startTime|Yes|Yes|Macola, M1, JobBOSS², Deacom
endTime|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_ShiftDays
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
shiftID[eq]: abc123
shiftDay[eq]: abc123
startTime[eq]: abc123
endTime[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/Shifts:
get:
tags:
- View
summary: Gets a list of Shift
description: 'Gets a list of Shift.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
shiftID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
inactiveDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_Shifts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
shiftID[eq]: abc123
shortDesc[eq]: abc123
inactiveDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
shiftDays|ShiftDays[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shift'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shift'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/TimecardLines:
get:
tags:
- View
summary: Gets a list of TimecardLine
description: 'Gets a list of TimecardLine.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timecardID|Yes|Yes|Macola, M1, JobBOSS², Deacom
timecardLine|Yes|Yes|Macola, M1, JobBOSS², Deacom
jobID|Yes|Yes|Macola, M1, JobBOSS², Deacom
jobAssembly|Yes|Yes|Macola, M1, JobBOSS², Deacom
jobOperation|Yes|Yes|Macola, M1, JobBOSS², Deacom
workCenterID|Yes|Yes|Macola, M1, JobBOSS², Deacom
processID|Yes|Yes|Macola, M1, JobBOSS², Deacom
status|Yes|Yes|Macola, M1, JobBOSS², Deacom
timecardType|Yes|Yes|Macola, M1, JobBOSS², Deacom
goodQty|Yes|Yes|Macola, M1, JobBOSS², Deacom
scrapQty|Yes|Yes|Macola, M1, JobBOSS², Deacom
reworkQty|Yes|Yes|Macola, M1, JobBOSS², Deacom
rejectQty|Yes|Yes|Macola, M1, JobBOSS², Deacom
startTime|Yes|Yes|Macola, M1, JobBOSS², Deacom
endTime|Yes|Yes|Macola, M1, JobBOSS², Deacom
machineHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
laborHours|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_TimecardLines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timecardID[eq]: abc123
timecardLine[eq]: abc123
jobID[eq]: abc123
jobAssembly[eq]: abc123
jobOperation[gte]: 123
workCenterID[eq]: abc123
processID[eq]: abc123
status[eq]: abc123
timecardType[eq]: abc123
goodQty[gte]: 123
scrapQty[gte]: 123
reworkQty[gte]: 123
rejectQty[gte]: 123
startTime[gte]: '2020-09-25T04:03:00.0000000'
endTime[gte]: '2020-09-25T04:03:00.0000000'
machineHours[gte]: 123
laborHours[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
workCenters|WorkCenters[]|
timecards|Timecards[]|
jobs|Jobs|
processes|Processes|
jobOperations|JobOperations|
salesOrderDeliveries|SalesOrderDeliveries[]|
salesOrderJobs|SalesOrderJobs|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimecardLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimecardLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/Timecards:
get:
tags:
- View
summary: Gets a list of Timecard
description: 'Gets a list of Timecard.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timecardID|Yes|Yes|Macola, M1, JobBOSS², Deacom
employeeID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shiftID|Yes|Yes|Macola, M1, JobBOSS², Deacom
timecardDate|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_Timecards
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timecardID[eq]: abc123
employeeID[eq]: abc123
shiftID[eq]: abc123
timecardDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
timecardlines|Timecardlines[]|
employees|Employees[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Timecard'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Timecard'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/TimeZones:
get:
tags:
- View
summary: Gets a list of TimeZone
description: 'Gets a list of TimeZone.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timeZoneName|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1'
operationId: GET__api_v1_view_TimeZones
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timeZoneName[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeZone'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeZone'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v1/view/WorkCenters:
get:
tags:
- View
summary: Gets a list of WorkCenter
description: 'Gets a list of WorkCenter.
## Supported ERPs
- Macola
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
workCenterID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shortDesc|Yes|Yes|Macola, M1, JobBOSS², Deacom
deptID|Yes|Yes|Macola, M1, JobBOSS², Deacom
overHeadRate|Yes|Yes|Macola, M1, JobBOSS², Deacom
quoteRate|Yes|Yes|Macola, M1, JobBOSS², Deacom
processID|Yes|Yes|Macola, M1, JobBOSS², Deacom
parentWorkCenterID|Yes|Yes|Macola, M1, JobBOSS², Deacom
shiftID|Yes|Yes|Macola, M1, JobBOSS², Deacom
uniqueID|Yes|Yes|Macola, M1, JobBOSS², Deacom
rowVersion|Yes|Yes|Macola, M1, JobBOSS², Deacom'
operationId: GET__api_v1_view_WorkCenters
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
workCenterID[eq]: abc123
shortDesc[eq]: abc123
deptID[eq]: abc123
overHeadRate[eq]: abc123
quoteRate[eq]: abc123
processID[eq]: abc123
parentWorkCenterID[eq]: abc123
shiftID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
departments|Departments[]|
shifts|Shifts[]|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenter'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenter'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/ap-invoice-lines:
get:
tags:
- View
summary: Gets a list of APInvoiceLine
description: 'Gets a list of APInvoiceLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1
lineID|No|Yes|M1
itemType|No|Yes|M1
partID|No|Yes|M1
partRevisionID|No|Yes|M1
partDescription|No|Yes|M1
purchaseQuantity|No|Yes|M1
baseUnitCost|No|Yes|M1
foreignUnitCost|No|Yes|M1
baseExtendedCost|No|Yes|M1
foreignExtendedCost|No|Yes|M1
baseSetupCharge|No|Yes|M1
foreignSetupCharge|No|Yes|M1
unitOfMeasure|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1'
operationId: GET__api_v2.1_view_ap-invoice-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoiceLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoiceLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/ap-invoices:
get:
tags:
- View
summary: Gets a list of APInvoice
description: 'Gets a list of APInvoice.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1, Macola
invoiceDate|Yes|Yes|M1, Macola
dueDate|Yes|Yes|M1, Macola
invoiceType|Yes|Yes|M1, Macola
isPostedToGL|Yes|Yes|M1, Macola
postedDate|Yes|Yes|M1, Macola
isOnHold|Yes|Yes|M1, Macola
isOverpayment|No|Yes|M1, Macola
paymentTermID|No|Yes|M1, Macola
baseTotal|No|Yes|M1, Macola
foreignTotal|No|Yes|M1, Macola
baseBalance|No|Yes|M1, Macola
foreignBalance|No|Yes|M1, Macola
uniqueID|No|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
currency|No|Yes|M1, Macola
supplierID|No|Yes|M1, Macola
paidDate|No|Yes|M1, Macola
plantID|No|Yes|M1, Macola'
operationId: GET__api_v2.1_view_ap-invoices
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
invoiceDate[gte]: '2020-09-25T00:00:00.0000000'
dueDate[gte]: '2020-09-25T00:00:00.0000000'
invoiceType[gte]: 123
isPostedToGL[eq]: true
postedDate[gte]: '2020-09-25T00:00:00.0000000'
isOnHold[eq]: true
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoice'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoice'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/ar-invoices:
get:
tags:
- View
summary: Gets a list of ARInvoice
description: 'Gets a list of ARInvoice.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1, Macola
invoiceDate|Yes|Yes|M1, Macola
dueDate|Yes|Yes|M1, Macola
invoiceType|Yes|Yes|M1, Macola
isPostedToGL|Yes|Yes|M1, Macola
postedDate|Yes|Yes|M1, Macola
isOnHold|Yes|Yes|M1, Macola
isOverpayment|Yes|Yes|M1, Macola
paymentTermID|Yes|Yes|M1, Macola
invoiceTotalBase|Yes|Yes|M1, Macola
invoiceTotalForeign|No|Yes|M1, Macola
invoiceBalanceBase|No|Yes|M1, Macola
invoiceBalanceForeign|No|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
customerID|No|Yes|M1, Macola
paidDate|No|Yes|M1, Macola
plantID|No|Yes|M1, Macola'
operationId: GET__api_v2.1_view_ar-invoices
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
invoiceDate[gte]: '2020-09-25T00:00:00.0000000'
dueDate[gte]: '2020-09-25T00:00:00.0000000'
invoiceType[gte]: 123
isPostedToGL[eq]: true
postedDate[gte]: '2020-09-25T00:00:00.0000000'
isOnHold[eq]: true
isOverpayment[eq]: true
paymentTermID[eq]: abc123
invoiceTotalBase[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoice'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoice'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/ar-invoice-sales-people:
get:
tags:
- View
summary: Gets a list of ARInvoiceSalesPerson
description: 'Gets a list of ARInvoiceSalesPerson.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1, Macola
employeeID|Yes|Yes|M1, Macola
sequenceID|No|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_ar-invoice-sales-people
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
employeeID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoiceSalesPerson'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoiceSalesPerson'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/contacts:
get:
tags:
- View
summary: Gets a list of Contact
description: 'Gets a list of Contact.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
contactID|Yes|Yes|M1, JobBOSS², Macola
name|Yes|Yes|M1, JobBOSS², Macola
organizationID|Yes|Yes|M1, JobBOSS², Macola
organizationTypes|Yes|Yes|JobBOSS²
phoneNumber|Yes|Yes|M1, JobBOSS², Macola
emailAddress|Yes|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
comments|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_contacts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
contactID[eq]: abc123
name[eq]: abc123
organizationID[eq]: abc123
organizationTypes[gte]: 123
phoneNumber[eq]: abc123
emailAddress[eq]: abc123
isActive[eq]: true
comments[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
organization|Organizations|The organization to which the Contact belongs.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Contact'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Contact'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/cycle-codes:
get:
tags:
- View
summary: Gets a list of CycleCode
description: 'Gets a list of CycleCode.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
cycleCodeID|Yes|Yes|M1'
operationId: GET__api_v2.1_view_cycle-codes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
cycleCodeID[eq]: abc123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CycleCode'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CycleCode'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/departments:
get:
tags:
- View
summary: Gets a list of Department
description: 'Gets a list of Department.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
deptID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2.1_view_departments
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
deptID[eq]: abc123
shortDesc[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Department'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Department'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/dmr-claim-lines:
get:
tags:
- View
summary: Gets a list of DmrClaimLine
description: 'Gets a list of DmrClaimLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
claimLineID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
partShortDescription|No|Yes|M1
partLongDescription|No|Yes|M1
partWarehouseID|Yes|Yes|M1
quantity|No|Yes|M1
quantityShipped|No|Yes|M1
unitOfMeasure|No|Yes|M1
unitCost|No|Yes|M1
foreignUnitCost|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
claimID|Yes|Yes|M1'
operationId: GET__api_v2.1_view_dmr-claim-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
claimLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
claimID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
claim|DmrClaims|
part|Parts|
partRevision|PartRevisions|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaimLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaimLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/dmr-claims:
get:
tags:
- View
summary: Gets a list of DmrClaim
description: 'Gets a list of DmrClaim.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
claimID|Yes|Yes|M1
supplierOrganizationID|Yes|Yes|M1
claimDate|Yes|Yes|M1
claimTotal|No|Yes|M1
foreignTotal|No|Yes|M1
currency|No|Yes|M1
plantID|Yes|Yes|M1
projectID|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
status|No|Yes|M1'
operationId: GET__api_v2.1_view_dmr-claims
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
claimID[eq]: abc123
supplierOrganizationID[eq]: abc123
claimDate[gte]: '2020-09-25T00:00:00.0000000'
plantID[eq]: abc123
projectID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
supplier|Organizations|
plant|Plants|
project|Projects|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaim'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaim'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/employees:
get:
tags:
- View
summary: Gets a list of Employee
description: 'Gets a list of Employee.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
employeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom
firstName|Yes|Yes|M1, JobBOSS², Macola, Deacom
lastName|Yes|Yes|M1, JobBOSS², Macola, Deacom
title|Yes|Yes|M1, JobBOSS², Macola, Deacom
supervisorEmployeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom
payRate|Yes|Yes|M1, JobBOSS², Macola, Deacom
deptID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom
isActive|Yes|Yes|JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2.1_view_employees
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
employeeID[eq]: abc123
firstName[eq]: abc123
lastName[eq]: abc123
title[eq]: abc123
supervisorEmployeeID[eq]: abc123
payRate[gte]: 123
deptID[eq]: abc123
shiftID[eq]: abc123
isActive[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Employee_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Employee_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/gl-codes:
get:
tags:
- View
summary: Gets a list of GLCode
description: 'Gets a list of GLCode.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|JobBOSS²
glCodeID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
isActive|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_gl-codes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
glCodeID[eq]: abc123
rowVersion[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
isActive[eq]: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GLCode'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GLCode'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/inspection-lines:
get:
tags:
- View
summary: Gets a list of InspectionLine
description: 'Gets a list of InspectionLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
notes|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
inspectionID|Yes|Yes|M1
inspectionLineID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
partWarehouseID|Yes|Yes|M1
partBinID|Yes|Yes|M1
quantityToInspect|No|Yes|M1
supplierOrganizationID|Yes|Yes|M1
isInspectionComplete|Yes|Yes|M1
unitCost|No|Yes|M1
projectID|Yes|Yes|M1
projectAreaID|Yes|Yes|M1
inspectionDate|No|Yes|M1
sourceType|Yes|Yes|M1
inspectorEmployeeID|Yes|Yes|M1'
operationId: GET__api_v2.1_view_inspection-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
inspectionID[eq]: abc123
inspectionLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
supplierOrganizationID[eq]: abc123
isInspectionComplete[eq]: true
projectID[eq]: abc123
projectAreaID[eq]: abc123
sourceType[gte]: 123
inspectorEmployeeID[eq]: abc123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/InspectionLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/InspectionLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/job-assemblies:
get:
tags:
- View
summary: Gets a list of JobAssembly
description: 'Gets a list of JobAssembly.
## Supported ERPs
- M1
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|M1, Deacom
jobAssemblyID|Yes|Yes|M1, Deacom
level|No|Yes|M1, Deacom
parentAssemblyID|No|Yes|M1, Deacom
sourceMethodID|No|Yes|M1, Deacom
sourceRevisionID|No|Yes|M1, Deacom
partID|Yes|Yes|M1, Deacom
partRevisionID|Yes|Yes|M1, Deacom
partShortDesc|No|Yes|M1, Deacom
quantityPerParent|No|Yes|M1, Deacom
orderQty|No|Yes|M1, Deacom
inventoryQty|No|Yes|M1, Deacom
scrapQty|No|Yes|M1, Deacom
quantityToInspect|No|Yes|M1, Deacom
quantityRcvdToInv|No|Yes|M1, Deacom
productionQty|No|Yes|M1, Deacom
quantityToMake|No|Yes|M1, Deacom
quantityToPull|No|Yes|M1, Deacom
quantityIssued|No|Yes|M1, Deacom
quantityCompleted|No|Yes|M1, Deacom
isProductionComplete|No|Yes|M1, Deacom
completedDate|No|Yes|M1, Deacom
uniqueID|Yes|Yes|M1, Deacom
rowVersion|Yes|Yes|M1, Deacom
jobIsClosed|Yes|Yes|M1, Deacom
jobClosedDate|Yes|Yes|M1, Deacom'
operationId: GET__api_v2.1_view_job-assemblies
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssemblyID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
jobIsClosed[eq]: true
jobClosedDate[gte]: '2020-09-25T04:03:00.0000000'
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobAssembly'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobAssembly'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/job-materials:
get:
tags:
- View
summary: Gets a list of JobMaterial
description: 'Gets a list of JobMaterial.
## Supported ERPs
- JobBOSS²
- M1
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|JobBOSS², M1, Deacom
jobAssemblyID|Yes|Yes|JobBOSS², M1, Deacom
jobAssemblySeq|No|Yes|M1
materialPartID|Yes|Yes|JobBOSS², M1, Deacom
materialPartRevisionID|Yes|Yes|JobBOSS², M1, Deacom
estQuantity|No|Yes|JobBOSS², M1, Deacom
estUnitCost|No|Yes|JobBOSS², M1, Deacom
unitOfMeasure|No|Yes|JobBOSS², M1, Deacom
leadTime|No|Yes|JobBOSS², M1, Deacom
vendorID|Yes|Yes|JobBOSS², M1, Deacom
uniqueID|Yes|Yes|JobBOSS², M1, Deacom
rowVersion|Yes|Yes|JobBOSS², M1, Deacom
jobIsClosed|Yes|Yes|JobBOSS², M1, Deacom
jobClosedDate|Yes|Yes|JobBOSS², M1, Deacom
jobType|Yes|Yes|Deacom'
operationId: GET__api_v2.1_view_job-materials
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssemblyID[eq]: abc123
materialPartID[eq]: abc123
materialPartRevisionID[eq]: abc123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
jobIsClosed[eq]: true
jobClosedDate[gte]: '2020-09-25T04:03:00.0000000'
jobType[eq]: abc123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobMaterial'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobMaterial'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/job-operations:
get:
tags:
- View
summary: Gets a list of JobOperation
description: 'Gets a list of JobOperation.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobAssembly|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobOperationSeq|Yes|Yes|M1, JobBOSS², Macola, Deacom
status|Yes|Yes|M1, JobBOSS², Macola, Deacom
workCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
processID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescFormatted|No|Yes|M1, JobBOSS², Macola, Deacom
outsideOperation|Yes|Yes|M1, JobBOSS², Macola, Deacom
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
schedStartDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
schedEndDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
actStartDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
actEndDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupHours|No|Yes|M1, JobBOSS², Macola, Deacom
estProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQueueHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estMoveHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
actSetupHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
actualProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
actQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
vendorID|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupTimeValue|No|Yes|JobBOSS²
estSetupTimeUnit|No|Yes|JobBOSS²
estProdTimeValue|No|Yes|JobBOSS²
estProdTimeUnit|No|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
operationQty|No|Yes|M1, JobBOSS², Macola, Deacom
quantityComplete|No|Yes|M1, JobBOSS², Macola, Deacom
isSetupComplete|No|Yes|M1, JobBOSS², Macola, Deacom
plantID|No|Yes|M1, JobBOSS², Macola, Deacom
purchaseOrderID|No|Yes|M1, JobBOSS², Macola, Deacom
supplierOrganizationID|No|Yes|M1, JobBOSS², Macola, Deacom
purchaseLocationID|No|Yes|M1, JobBOSS², Macola, Deacom
RFQID|No|Yes|M1, JobBOSS², Macola, Deacom
defaultEmployeeID|Yes|Yes|JobBOSS²
defaultEmployeeID2|Yes|Yes|JobBOSS²
defaultEmployeeID3|Yes|Yes|JobBOSS²
isUnattended|No|Yes|JobBOSS²
jobType|Yes|Yes|Deacom
supplierLeadTime|No|Yes|JobBOSS²
jobIsClosed|Yes|Yes|JobBOSS², M1, Deacom
jobClosedDate|Yes|Yes|JobBOSS², M1, Deacom'
operationId: GET__api_v2.1_view_job-operations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssembly[eq]: abc123
jobOperationSeq[gte]: 123
status[eq]: abc123
workCenterID[eq]: abc123
processID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
outsideOperation[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
schedStartDate[gte]: '2020-09-25T04:03:00.0000000'
schedEndDate[gte]: '2020-09-25T04:03:00.0000000'
actStartDate[gte]: '2020-09-25T04:03:00.0000000'
actEndDate[gte]: '2020-09-25T04:03:00.0000000'
estProdHours[gte]: 123
estQueueHours[gte]: 123
estMoveHours[gte]: 123
estQAHours[gte]: 123
actSetupHours[gte]: 123
actualProdHours[gte]: 123
actQAHours[gte]: 123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
defaultEmployeeID[eq]: abc123
defaultEmployeeID2[eq]: abc123
defaultEmployeeID3[eq]: abc123
jobType[eq]: abc123
jobIsClosed[eq]: true
jobClosedDate[gte]: '2020-09-25T04:03:00.0000000'
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobOperation_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobOperation_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/jobs:
get:
tags:
- View
summary: Gets a list of Job
description: 'Gets a list of Job.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|M1, JobBOSS², Macola, Deacom
customerID|No|Yes|M1, JobBOSS², Macola, Deacom
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
orderQty|No|Yes|M1, JobBOSS², Macola, Deacom
prodQty|No|Yes|M1, JobBOSS², Macola, Deacom
schedStartDate|No|Yes|M1, JobBOSS², Macola, Deacom
schedEndDate|No|Yes|M1, JobBOSS², Macola, Deacom
estLeadTime|No|Yes|M1, JobBOSS², Macola, Deacom
actStartDate|No|Yes|M1, JobBOSS², Macola, Deacom
actEndDate|No|Yes|M1, JobBOSS², Macola, Deacom
dueDate|No|Yes|M1, JobBOSS², Macola, Deacom
status|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobCost|No|Yes|M1, JobBOSS², Macola, Deacom
jobCostForeign|No|Yes|M1, JobBOSS², Macola, Deacom
plantID|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
partWarehouseID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partBinID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partShortDesc|No|Yes|M1, JobBOSS², Macola, Deacom
inventoryQty|No|Yes|M1, JobBOSS², Macola, Deacom
isPlanningComplete|Yes|Yes|M1, JobBOSS², Macola, Deacom
isScheduleComplete|Yes|Yes|M1, JobBOSS², Macola, Deacom
isReleasedToFloor|Yes|Yes|M1, JobBOSS², Macola, Deacom
isOnHold|Yes|Yes|M1, JobBOSS², Macola, Deacom
completedDate|No|Yes|M1, JobBOSS², Macola, Deacom
quantityCompleted|No|Yes|M1, JobBOSS², Macola, Deacom
quantityShipped|No|Yes|M1, JobBOSS², Macola, Deacom
quantityRcvdToInventory|No|Yes|M1, JobBOSS², Macola, Deacom
projectID|Yes|Yes|M1, JobBOSS², Macola, Deacom
projectAreaID|Yes|Yes|M1, JobBOSS², Macola, Deacom
isClosed|Yes|Yes|M1, JobBOSS², Macola, Deacom
closedDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobPriorityID|Yes|Yes|M1, JobBOSS², Macola, Deacom
unitOfMeasure|No|Yes|M1, JobBOSS², Macola, Deacom
plannerEmployeeID|No|Yes|M1, JobBOSS², Macola, Deacom
parentJobID|Yes|Yes|JobBOSS²
shortDesc|No|Yes|Deacom
childJobID|No|Yes|Deacom
jobType|Yes|Yes|Deacom'
operationId: GET__api_v2.1_view_jobs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
status[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
plantID[eq]: abc123
jobDate[gte]: '2020-09-25T04:03:00.0000000'
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
isPlanningComplete[eq]: true
isScheduleComplete[eq]: true
isReleasedToFloor[eq]: true
isOnHold[eq]: true
projectID[eq]: abc123
projectAreaID[eq]: abc123
isClosed[eq]: true
closedDate[gte]: '2020-09-25T04:03:00.0000000'
jobPriorityID[eq]: abc123
parentJobID[eq]: abc123
jobType[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
jobOperations|JobOperations[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Job_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Job_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/locations:
get:
tags:
- View
summary: Gets a list of Location
description: 'Gets a list of Location.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
locationID|Yes|Yes|M1, JobBOSS², Macola
name|Yes|Yes|M1, JobBOSS², Macola
organizationID|Yes|Yes|M1, JobBOSS², Macola
organizationTypes|Yes|Yes|JobBOSS²
addressLine1|No|Yes|M1, JobBOSS², Macola
addressLine2|No|Yes|M1, JobBOSS², Macola
addressLine3|No|Yes|M1, JobBOSS², Macola
city|Yes|Yes|M1, JobBOSS², Macola
county|Yes|Yes|M1, JobBOSS², Macola
country|Yes|Yes|M1, JobBOSS², Macola
postalCode|Yes|Yes|M1, JobBOSS², Macola
state|Yes|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
locationTypes|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_locations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
locationID[eq]: abc123
name[eq]: abc123
organizationID[eq]: abc123
organizationTypes[gte]: 123
city[eq]: abc123
county[eq]: abc123
country[eq]: abc123
postalCode[eq]: abc123
state[eq]: abc123
isActive[eq]: true
locationTypes[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
organization|Organizations|The organization to which the Location belongs.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Location'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Location'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/organization-parts:
get:
tags:
- View
summary: Gets a list of OrganizationPart
description: 'Gets a list of OrganizationPart.
## Supported ERPs
- JobBOSS²
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|JobBOSS², M1
partRevisionID|Yes|Yes|JobBOSS², M1
organizationID|Yes|Yes|JobBOSS², M1
organizationTypes|Yes|Yes|JobBOSS²
organizationPartID|Yes|Yes|JobBOSS², M1
organizationShortDesc|No|Yes|JobBOSS², M1
uniqueID|Yes|Yes|JobBOSS², M1
rowVersion|Yes|Yes|JobBOSS², M1'
operationId: GET__api_v2.1_view_organization-parts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
organizationID[eq]: abc123
organizationTypes[gte]: 123
organizationPartID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OrganizationPart'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OrganizationPart'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/organizations:
get:
tags:
- View
summary: Gets a list of Organization
description: 'Gets a list of Organization.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
name|Yes|Yes|M1, JobBOSS², Macola
organizationID|Yes|Yes|M1, JobBOSS², Macola
country|Yes|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
organizationTypes|Yes|Yes|JobBOSS², Macola
phoneNumber|Yes|Yes|JobBOSS²
customerPaymentTermID|Yes|Yes|JobBOSS²
customerTaxCodeID|Yes|Yes|JobBOSS²
supplierPaymentTermID|Yes|Yes|JobBOSS²
supplierTaxCodeID|Yes|Yes|JobBOSS²
currencyCode|Yes|Yes|JobBOSS²
websiteUrl|No|Yes|JobBOSS²
comments|No|Yes|JobBOSS²
salesAccountID|Yes|Yes|JobBOSS²
leadTimeDays|No|Yes|JobBOSS²
minimumOrderAmount|No|Yes|JobBOSS²
customerStatus|Yes|Yes|M1
supplierStatus|Yes|Yes|M1'
operationId: GET__api_v2.1_view_organizations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
name[eq]: abc123
organizationID[eq]: abc123
country[eq]: abc123
isActive[eq]: true
organizationTypes[gte]: 123
phoneNumber[eq]: abc123
customerPaymentTermID[eq]: abc123
customerTaxCodeID[eq]: abc123
supplierPaymentTermID[eq]: abc123
supplierTaxCodeID[eq]: abc123
currencyCode[eq]: abc123
salesAccountID[eq]: abc123
customerStatus[gte]: 123
supplierStatus[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Organization'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Organization'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-bins:
get:
tags:
- View
summary: Gets a list of PartBin
description: 'Gets a list of PartBin.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partRevisionID|Yes|Yes|M1, JobBOSS², Deacom
warehouseID|Yes|Yes|M1, JobBOSS², Deacom
partBinID|Yes|Yes|M1, JobBOSS², Deacom
quantityOnHand|No|Yes|M1, JobBOSS², Deacom
quantityAllocated|No|Yes|M1, JobBOSS², Deacom
quantityOnOrderSales|No|Yes|M1, JobBOSS², Deacom
quantityOnOrderPurchases|No|Yes|M1, JobBOSS², Deacom
quantityToInspect|No|Yes|M1, JobBOSS², Deacom
quantityToReturn|No|Yes|M1, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
partID|Yes|Yes|M1, JobBOSS², Deacom
lotNumber|Yes|Yes|JobBOSS²
purchaseOrderLineID|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_part-bins
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partRevisionID[eq]: abc123
warehouseID[eq]: abc123
partBinID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
partID[eq]: abc123
lotNumber[eq]: abc123
purchaseOrderLineID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
partRevision|PartRevisions|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartBin'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartBin'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-classes:
get:
tags:
- View
summary: Gets a list of PartClass
description: 'Gets a list of PartClass.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
partClassID|No|Yes|M1
isActive|Yes|Yes|M1'
operationId: GET__api_v2.1_view_part-classes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isActive[eq]: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartClass'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartClass'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-cost-breaks:
get:
tags:
- View
summary: Gets a list of PartCostBreak
description: 'Gets a list of PartCostBreak.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partCostID|Yes|Yes|JobBOSS²
quantity|No|Yes|JobBOSS²
unitCost|No|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_part-cost-breaks
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partCostID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartCostBreak'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartCostBreak'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-costs:
get:
tags:
- View
summary: Gets a list of PartRevision
description: 'Gets a list of PartRevision.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partCostID|Yes|Yes|JobBOSS²
partID|Yes|Yes|JobBOSS²
partRevisionID|Yes|Yes|JobBOSS²
startDate|Yes|Yes|JobBOSS²
endDate|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_part-costs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partCostID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
startDate[gte]: '2020-09-25T04:03:00.0000000'
endDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-groups:
get:
tags:
- View
summary: Gets a list of PartGroup
description: 'Gets a list of PartGroup.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
partGroupID|Yes|Yes|M1, JobBOSS², Macola
parentPartGroupID|Yes|Yes|M1, JobBOSS², Macola
description|No|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
inactiveDate|No|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2.1_view_part-groups
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
partGroupID[eq]: abc123
parentPartGroupID[eq]: abc123
isActive[eq]: true
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartGroup'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartGroup'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-materials:
get:
tags:
- View
summary: Gets a list of PartMaterial
description: 'Gets a list of PartMaterial.
## Supported ERPs
- JobBOSS²
- M1
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|JobBOSS², M1, Deacom
partRevisionID|Yes|Yes|JobBOSS², M1, Deacom
partOperationSeq|Yes|Yes|JobBOSS², M1, Deacom
materialPartID|Yes|Yes|JobBOSS², M1, Deacom
materialPartRevisionID|Yes|Yes|JobBOSS², M1, Deacom
uniqueID|Yes|Yes|JobBOSS², M1, Deacom
rowVersion|Yes|Yes|JobBOSS², M1, Deacom
quantity|No|Yes|JobBOSS², M1, Deacom
unitOfMeasure|No|Yes|JobBOSS², M1, Deacom
partAssemblyID|No|Yes|M1
partAssemblySeq|No|Yes|M1'
operationId: GET__api_v2.1_view_part-materials
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
partOperationSeq[gte]: 123
materialPartID[eq]: abc123
materialPartRevisionID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartMaterial'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartMaterial'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-operations:
get:
tags:
- View
summary: Gets a list of PartOperation
description: 'Gets a list of PartOperation.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partOperationSeq|Yes|Yes|M1, JobBOSS², Macola, Deacom
workCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
processID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescFormatted|Yes|Yes|M1, JobBOSS², Macola, Deacom
outsideOperation|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQueueHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estMoveHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
vendorID|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupTimeValue|No|Yes|JobBOSS²
estSetupTimeUnit|No|Yes|JobBOSS²
estProdTimeValue|No|Yes|JobBOSS²
estProdTimeUnit|No|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2.1_view_part-operations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
partOperationSeq[gte]: 123
workCenterID[eq]: abc123
processID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
longDescFormatted[eq]: abc123
outsideOperation[eq]: abc123
estSetupHours[gte]: 123
estProdHours[gte]: 123
estQueueHours[gte]: 123
estMoveHours[gte]: 123
estQAHours[gte]: 123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartOperation_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartOperation_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-price-breaks:
get:
tags:
- View
summary: Gets a list of PartPriceBreak
description: 'Gets a list of PartPriceBreak.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partPriceID|Yes|Yes|JobBOSS²
quantity|No|Yes|JobBOSS²
unitPrice|No|Yes|JobBOSS²
markup|No|Yes|JobBOSS²
discount|No|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_part-price-breaks
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partPriceID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPriceBreak'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPriceBreak'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-prices:
get:
tags:
- View
summary: Gets a list of PartPrice
description: 'Gets a list of PartPrice.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partPriceID|Yes|Yes|JobBOSS²
partID|Yes|Yes|JobBOSS²
partRevisionID|Yes|Yes|JobBOSS²
startDate|Yes|Yes|JobBOSS²
endDate|Yes|Yes|JobBOSS²
isCustomerSpecific|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_part-prices
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partPriceID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
startDate[gte]: '2020-09-25T04:03:00.0000000'
endDate[gte]: '2020-09-25T04:03:00.0000000'
isCustomerSpecific[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPrice'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPrice'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-revisions:
get:
tags:
- View
summary: Gets a list of PartRevision
description: 'Gets a list of PartRevision.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescFormatted|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
partCost|No|Yes|M1, JobBOSS², Macola, Deacom
effectiveStartDate|No|Yes|JobBOSS²
expirationEndDate|No|Yes|JobBOSS²
supplierOrganizationID|No|Yes|JobBOSS²
leadTime|No|Yes|JobBOSS²
quantityOnHand|No|Yes|JobBOSS²
pricingUnitOfMeasure|No|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_part-revisions
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
longDescFormatted[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/parts:
get:
tags:
- View
summary: Gets a list of Part
description: 'Gets a list of Part.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partClassID|No|Yes|M1, JobBOSS², Deacom
partGroupID|Yes|Yes|M1, JobBOSS², Deacom
cycleCodeID|No|Yes|M1, JobBOSS², Deacom
partType|Yes|Yes|M1, JobBOSS², Deacom
partID|Yes|Yes|M1, JobBOSS², Deacom
alternatePartID|No|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
isActive|Yes|Yes|M1, JobBOSS², Deacom'
operationId: GET__api_v2.1_view_parts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partGroupID[eq]: abc123
partType[gte]: 123
partID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isActive[eq]: true
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
partClass|PartClasses|
partGroup|PartGroups|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Part'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Part'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/part-transactions:
get:
tags:
- View
summary: Gets a list of PartTransaction
description: 'Gets a list of PartTransaction.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partTransactionID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
transactionType|Yes|Yes|M1
source|Yes|Yes|M1
receiptType|Yes|Yes|M1
isNonInventoryTransaction|No|Yes|M1
purchaseOrderID|Yes|Yes|M1
jobID|Yes|Yes|M1
partWarehouseID|Yes|Yes|M1
partBinID|Yes|Yes|M1
supplierOrganizationID|Yes|Yes|M1
inventoryQtyRcvd|No|Yes|M1
scrapQty|No|Yes|M1
quantityToInspect|No|Yes|M1
quantityToReturn|No|Yes|M1
purchaseQtyRcvd|No|Yes|M1
purchaseUnitCost|No|Yes|M1
transactionDate|Yes|Yes|M1
reference|No|Yes|M1
shipmentID|No|Yes|M1
shipmentLineID|No|Yes|M1
receiptID|No|Yes|M1
DMRShipmentID|No|Yes|M1
RMAReceiptID|No|Yes|M1
inspectionID|No|Yes|M1
inventoryCountID|No|Yes|M1
warehouseTransferID|No|Yes|M1
warehouseReceiptID|No|Yes|M1
projectID|No|Yes|M1
projectAreaID|No|Yes|M1
plantID|No|Yes|M1
costType|No|Yes|M1
quantity|No|Yes|M1
unitLaborCost|No|Yes|M1
unitOverheadCost|No|Yes|M1
unitMaterialCost|No|Yes|M1
unitSubcontractCost|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1'
operationId: GET__api_v2.1_view_part-transactions
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partTransactionID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
transactionType[gte]: 123
source[gte]: 123
receiptType[gte]: 123
purchaseOrderID[eq]: abc123
jobID[eq]: abc123
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
supplierOrganizationID[eq]: abc123
transactionDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartTransaction'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartTransaction'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/payment-terms:
get:
tags:
- View
summary: Gets a list of PaymentTerm
description: 'Gets a list of PaymentTerm.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1, JobBOSS², Macola
paymentTermID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
uniqueID|Yes|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2.1_view_payment-terms
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
paymentTermID[eq]: abc123
rowVersion[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentTerm'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentTerm'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/plants:
get:
tags:
- View
summary: Gets a list of Plant
description: 'Gets a list of Plant.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
plantID|Yes|Yes|M1, Macola
name|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_plants
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
plantID[eq]: abc123
name[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Plant'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Plant'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/processes:
get:
tags:
- View
summary: Gets a list of Process
description: 'Gets a list of Process.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
processID|Yes|Yes|M1, Macola
shortDesc|Yes|Yes|M1, Macola
setupRate|Yes|Yes|M1, Macola
productionRate|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_processes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
processID[eq]: abc123
shortDesc[eq]: abc123
setupRate[eq]: abc123
productionRate[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Process'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Process'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/production-calendars:
get:
tags:
- View
summary: Gets a list of ProductionCalendar
description: 'Gets a list of ProductionCalendar.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
productionDate|Yes|Yes|M1, Macola
productionHours|Yes|Yes|M1, Macola
productionStartTime|Yes|Yes|M1, Macola
workCenterID|Yes|Yes|M1, Macola
plantID|Yes|Yes|M1, Macola
department|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_production-calendars
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
productionDate[gte]: '2020-09-25T04:03:00.0000000'
productionHours[gte]: 123
productionStartTime[eq]: abc123
workCenterID[eq]: abc123
plantID[eq]: abc123
department[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductionCalendar'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductionCalendar'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/projects:
get:
tags:
- View
summary: Gets a list of Project
description: 'Gets a list of Project.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
projectID|Yes|Yes|M1, Macola
customerID|Yes|Yes|M1, Macola
locationID|No|Yes|M1, Macola
contactID|No|Yes|M1, Macola
dueDate|No|Yes|M1, Macola
projectDate|Yes|Yes|M1, Macola
closedDate|No|Yes|M1, Macola
shortDescription|No|Yes|M1, Macola
longDescription|No|Yes|M1, Macola
statusCode|No|Yes|M1, Macola
isClosed|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_projects
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
projectID[eq]: abc123
customerID[eq]: abc123
projectDate[gte]: '2020-09-25T00:00:00.0000000'
isClosed[eq]: true
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|The Customer Organization.
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Project'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Project'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/purchase-order-lines:
get:
tags:
- View
summary: Gets a list of PurchaseOrderLine
description: 'Gets a list of PurchaseOrderLine.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
dueDate|Yes|Yes|M1, JobBOSS², Deacom
extendedCost|No|Yes|M1, JobBOSS², Deacom
foreignExtendedCost|No|Yes|M1, JobBOSS², Deacom
partID|Yes|Yes|M1, JobBOSS², Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Deacom
partDescription|No|Yes|M1, JobBOSS², Deacom
partWarehouse|No|Yes|M1, JobBOSS², Deacom
purchaseOrderLineID|Yes|Yes|M1, JobBOSS², Deacom
quantity|No|Yes|M1, JobBOSS², Deacom
quantityReceived|No|Yes|M1, JobBOSS², Deacom
unitCost|No|Yes|M1, JobBOSS², Deacom
foreignUnitCost|No|Yes|M1, JobBOSS², Deacom
isReceived|Yes|Yes|M1, JobBOSS², Deacom
inspectionRequired|Yes|Yes|M1, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
isClosed|Yes|Yes|M1, JobBOSS², Deacom
purchaseOrderID|Yes|Yes|M1, JobBOSS², Deacom
unitOfMeasure|No|Yes|JobBOSS², Deacom
jobID|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_purchase-order-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
dueDate[gte]: '2020-09-25T00:00:00.0000000'
partID[eq]: abc123
partRevisionID[eq]: abc123
purchaseOrderLineID[eq]: abc123
isReceived[eq]: true
inspectionRequired[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isClosed[eq]: true
purchaseOrderID[eq]: abc123
jobID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
purchaseOrder|PurchaseOrders|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrderLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrderLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/purchase-orders:
get:
tags:
- View
summary: Gets a list of PurchaseOrder
description: 'Gets a list of PurchaseOrder.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
apInvoiceLocationID|No|Yes|M1, JobBOSS², Deacom
buyerEmployeeID|No|Yes|M1, JobBOSS², Deacom
currency|No|Yes|M1, JobBOSS², Deacom
orderDate|Yes|Yes|M1, JobBOSS², Deacom
plantID|Yes|Yes|M1, JobBOSS², Deacom
projectID|Yes|Yes|M1, JobBOSS², Deacom
purchaseOrderID|Yes|Yes|M1, JobBOSS², Deacom
supplierOrganizationID|Yes|Yes|M1, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
isClosed|Yes|Yes|M1, JobBOSS², Deacom'
operationId: GET__api_v2.1_view_purchase-orders
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
orderDate[gte]: '2020-09-25T00:00:00.0000000'
plantID[eq]: abc123
projectID[eq]: abc123
purchaseOrderID[eq]: abc123
supplierOrganizationID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isClosed[eq]: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/quote-lines:
get:
tags:
- View
summary: Gets a list of QuoteLine
description: 'Gets a list of QuoteLine.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²
quoteID|Yes|Yes|M1, Macola, JobBOSS²
partID|Yes|Yes|M1, Macola, JobBOSS²
partRevisionID|Yes|Yes|M1, Macola, JobBOSS²
partGroupID|Yes|Yes|M1, Macola, JobBOSS²
shortDescription|No|Yes|M1, Macola, JobBOSS²
quoteQuantityID|No|Yes|M1, Macola, JobBOSS²
quoteLineID|Yes|Yes|M1, Macola, JobBOSS²
resolutionReasonID|No|Yes|M1, Macola, JobBOSS²
locationID|No|Yes|Macola'
operationId: GET__api_v2.1_view_quote-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
quoteID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partGroupID[eq]: abc123
quoteLineID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
quote|Quotes|The parent Quote header for this line.
resolutionReason|Reasons|The reason detail for the resolution.
partGroup|PartGroups|The parent Quote header for this line.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/quote-quantities:
get:
tags:
- View
summary: Provides a breakdown of pricing for quote line items based on any included…
description: 'Gets a list of QuoteQuantity.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²
quoteQuantityID|Yes|Yes|M1, Macola, JobBOSS²
quoteID|Yes|Yes|M1, Macola, JobBOSS²
quoteLineID|Yes|Yes|M1, Macola, JobBOSS²
quantity|No|Yes|M1, Macola, JobBOSS²
baseUnitPrice|No|Yes|M1, Macola, JobBOSS²
foreignUnitPrice|No|Yes|M1, Macola, JobBOSS²'
operationId: GET__api_v2.1_view_quote-quantities
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
quoteQuantityID[eq]: abc123
quoteID[eq]: abc123
quoteLineID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
quote|Quotes|The parent Quote header for this line.
quoteLine|QuoteLines|The relaed quote line.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteQuantity'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteQuantity'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/quotes:
get:
tags:
- View
summary: Gets a list of Quote
description: 'Gets a list of Quote.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²
quoteID|Yes|Yes|M1, Macola, JobBOSS²
employeeID|Yes|Yes|M1, Macola, JobBOSS²
organizationID|Yes|Yes|M1, Macola, JobBOSS²
locationID|Yes|Yes|M1, Macola, JobBOSS²
contactID|No|Yes|M1, Macola, JobBOSS²
invoiceLocationID|No|Yes|M1, Macola, JobBOSS²
quoteDate|Yes|Yes|M1, Macola, JobBOSS²
dueDate|No|Yes|M1, Macola, JobBOSS²
isClosed|Yes|Yes|M1, Macola, JobBOSS²
closedDate|Yes|Yes|M1, Macola, JobBOSS²
currencyRateID|No|Yes|M1, Macola, JobBOSS²
customerID|Yes|Yes|M1, Macola, JobBOSS²
expirationDate|Yes|Yes|M1, Macola, JobBOSS²
plantID|No|Yes|M1, Macola, JobBOSS²
projectID|No|Yes|M1, Macola, JobBOSS²
shipToOrganizationID|No|Yes|M1, Macola, JobBOSS²
shipToContactID|No|Yes|M1, Macola, JobBOSS²
shipToLocationID|No|Yes|M1, Macola, JobBOSS²
statusCode|No|Yes|M1, Macola, JobBOSS²
totalSalesAmount|No|Yes|Macola
awardProbability|No|Yes|Macola
lostSaleCode|No|Yes|Macola'
operationId: GET__api_v2.1_view_quotes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
quoteID[eq]: abc123
employeeID[eq]: abc123
organizationID[eq]: abc123
locationID[eq]: abc123
quoteDate[gte]: '2020-09-25T00:00:00.0000000'
isClosed[eq]: true
closedDate[gte]: '2020-09-25T00:00:00.0000000'
customerID[eq]: abc123
expirationDate[gte]: '2020-09-25T00:00:00.0000000'
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|The Customer Organization.
contact|Contacts|The Customer Contact record.
shipTo|Organizations|The Ship To Organization.
shipToContact|Contacts|The Ship To Contact record.
project|Projects|The Project record for this quote.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Quote'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Quote'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/quote-sales-people:
get:
tags:
- View
summary: Gets a list of QuoteSalesPerson
description: 'Gets a list of QuoteSalesPerson.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
quoteID|Yes|Yes|M1, Macola
employeeID|Yes|Yes|M1, Macola
percentage|No|Yes|M1, Macola
isClosed|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
sequenceNo|No|Yes|Macola'
operationId: GET__api_v2.1_view_quote-sales-people
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
quoteID[eq]: abc123
employeeID[eq]: abc123
isClosed[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
quote|Quotes|The parent Quote header for this line.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteSalesPerson'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteSalesPerson'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/reasons:
get:
tags:
- View
summary: Gets a list of Reason
description: 'Gets a list of Reason.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
reasonID|Yes|Yes|M1, Macola, JobBOSS²
description|No|Yes|M1, Macola, JobBOSS²
name|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²'
operationId: GET__api_v2.1_view_reasons
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
reasonID[eq]: abc123
name[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Reason'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Reason'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/rma-claim-lines:
get:
tags:
- View
summary: Gets a list of RmaClaimLine
description: 'Gets a list of RmaClaimLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
unitPrice|No|Yes|M1
foreignUnitPrice|No|Yes|M1
extendedPrice|No|Yes|M1
foreignExtendedPrice|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
claimID|Yes|Yes|M1
claimLineID|Yes|Yes|M1
quantity|No|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1'
operationId: GET__api_v2.1_view_rma-claim-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
claimID[eq]: abc123
claimLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
claim|RmaClaims|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaimLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaimLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/rma-claims:
get:
tags:
- View
summary: Gets a list of RmaClaim
description: 'Gets a list of RmaClaim.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
claimDate|Yes|Yes|M1
claimTotal|Yes|Yes|M1
foreignTotal|Yes|Yes|M1
currency|No|Yes|M1
customerOrganizationID|Yes|Yes|M1
plantID|Yes|Yes|M1
claimID|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
status|Yes|Yes|M1'
operationId: GET__api_v2.1_view_rma-claims
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
claimDate[gte]: '2020-09-25T00:00:00.0000000'
claimTotal[gte]: 123
foreignTotal[gte]: 123
customerOrganizationID[eq]: abc123
plantID[eq]: abc123
claimID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
status[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaim'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaim'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/rma-receipt-lines:
get:
tags:
- View
summary: Gets a list of RmaReceiptLine
description: 'Gets a list of RmaReceiptLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1
isInspected|Yes|Yes|M1
partID|Yes|Yes|M1
partLongDescription|No|Yes|M1
partRevisionID|Yes|Yes|M1
partWarehouseID|Yes|Yes|M1
projectID|Yes|Yes|M1
isReceived|Yes|Yes|M1
inspectionRequired|Yes|Yes|M1
claimLineID|Yes|Yes|M1
claimQuantity|Yes|Yes|M1
receiptID|Yes|Yes|M1
receiptLineID|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
isClosed|Yes|Yes|M1
isReversed|Yes|Yes|M1
claimID|Yes|Yes|M1'
operationId: GET__api_v2.1_view_rma-receipt-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
isInspected[eq]: true
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
projectID[eq]: abc123
isReceived[eq]: true
inspectionRequired[eq]: true
claimLineID[eq]: abc123
claimQuantity[gte]: 123
receiptID[eq]: abc123
receiptLineID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isClosed[eq]: true
isReversed[eq]: true
claimID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
claim|RmaClaims|
claimLine|RmaClaimLines|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaReceiptLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaReceiptLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/sales-accounts:
get:
tags:
- View
summary: Gets a list of SalesAccount
description: 'Gets a list of SalesAccount.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesAccountID|Yes|Yes|JobBOSS²
name|Yes|Yes|JobBOSS²
isActive|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_sales-accounts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesAccountID[eq]: abc123
name[eq]: abc123
isActive[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesAccount'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesAccount'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/sales-order-deliveries:
get:
tags:
- View
summary: Gets a list of SalesOrderDelivery
description: 'Gets a list of SalesOrderDelivery.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, Macola
orderLine|Yes|Yes|M1, Macola
orderLineDelivery|Yes|Yes|M1, Macola
promisedDate|Yes|Yes|M1, Macola
promisedQty|Yes|Yes|M1, Macola
shippedDate|Yes|Yes|M1, Macola
shippedQty|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
deliveryTypeCode|No|Yes|M1, Macola
salesOrderType|No|Yes|Macola'
operationId: GET__api_v2.1_view_sales-order-deliveries
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
orderLineDelivery[eq]: abc123
promisedDate[gte]: '2020-09-25T04:03:00.0000000'
promisedQty[gte]: 123
shippedDate[gte]: '2020-09-25T04:03:00.0000000'
shippedQty[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrderJobs|SalesOrderJobs[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/sales-order-jobs:
get:
tags:
- View
summary: Gets a list of SalesOrderJob
description: 'Gets a list of SalesOrderJob.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, JobBOSS², Macola
orderLine|Yes|Yes|M1, JobBOSS², Macola
orderLineDelivery|Yes|Yes|M1, JobBOSS², Macola
jobID|Yes|Yes|M1, JobBOSS², Macola
orderJobSeq|Yes|Yes|M1, JobBOSS², Macola
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2.1_view_sales-order-jobs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
orderLineDelivery[eq]: abc123
jobID[eq]: abc123
orderJobSeq[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/sales-order-lines:
get:
tags:
- View
summary: Gets a list of SalesOrderLine
description: 'Gets a list of SalesOrderLine.
## Supported ERPs
- M1
- Macola
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, Macola, JobBOSS², Deacom
orderLine|Yes|Yes|M1, Macola, JobBOSS², Deacom
totalSalePrice|Yes|Yes|M1, Macola, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, Macola, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, Macola, JobBOSS², Deacom
partID|No|Yes|M1, Macola, JobBOSS², Deacom
partRevisionID|No|Yes|M1, Macola, JobBOSS², Deacom
partGroupID|No|Yes|M1, Macola, JobBOSS², Deacom
shortDescription|No|Yes|M1, Macola, JobBOSS², Deacom
saleUom|No|Yes|M1, Macola, JobBOSS², Deacom
baseUnitPrice|No|Yes|M1, Macola, JobBOSS², Deacom
foreignUnitPrice|No|Yes|M1, Macola, JobBOSS², Deacom
baseExtendedPrice|No|Yes|M1, Macola, JobBOSS², Deacom
foreignExtendedPrice|No|Yes|M1, Macola, JobBOSS², Deacom
quantityOrdered|No|Yes|M1, Macola, JobBOSS², Deacom
quantityShipped|No|Yes|M1, Macola, JobBOSS², Deacom
purchaseOrderCost|No|Yes|M1, Macola, JobBOSS², Deacom
purchaseOrderCostForeign|No|Yes|M1, Macola, JobBOSS², Deacom
salesOrderType|No|Yes|Macola
locationID|No|Yes|Macola
shippedDate|No|Yes|Macola
isPosted|No|Yes|Macola
dueDate|No|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_sales-order-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
totalSalePrice[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrderDeliveries|SalesOrderDeliveries[]|
salesOrderJobs|SalesOrderJobs|
salesOrder|SalesOrders|
partRevision|PartRevisions|
partGroup|PartGroups|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderLine_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderLine_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/sales-orders:
get:
tags:
- View
summary: Gets a list of SalesOrder
description: 'Gets a list of SalesOrder.
## Supported ERPs
- M1
- Macola
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, Macola, JobBOSS², Deacom
salesOrderID|Yes|Yes|M1, Macola, JobBOSS², Deacom
customerID|Yes|Yes|M1, Macola, JobBOSS², Deacom
orderDate|Yes|Yes|M1, Macola, JobBOSS², Deacom
plantID|No|Yes|M1, Macola, JobBOSS², Deacom
projectID|No|Yes|M1, Macola, JobBOSS², Deacom
salesOrderType|No|Yes|Macola
totalSalesAmount|No|Yes|Macola
status|No|Yes|Macola
originalOrderType|No|Yes|Macola
quoteID|No|Yes|Macola
closedDate|Yes|Yes|Macola'
operationId: GET__api_v2.1_view_sales-orders
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
salesOrderID[eq]: abc123
customerID[eq]: abc123
orderDate[gte]: '2020-09-25T00:00:00.0000000'
closedDate[gte]: '2020-09-25T00:00:00.0000000'
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|The Customer Organization record.
plant|Plants|The Plant record.
project|Projects|The Project record for this Sales Order.
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrder'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrder'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/sales-order-sales-people:
get:
tags:
- View
summary: Gets a list of SalesOrderSalesPerson
description: 'Gets a list of SalesOrderSalesPerson.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, Macola
salesEmployeeID|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
isActive|Yes|Yes|M1, Macola
sequenceNo|No|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
salesOrderType|No|Yes|Macola
percentage|No|Yes|Macola'
operationId: GET__api_v2.1_view_sales-order-sales-people
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
salesEmployeeID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
isActive[eq]: true
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrder|SalesOrders|
salesEmployee|Employees|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderSalesPerson'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderSalesPerson'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/shift-days:
get:
tags:
- View
summary: Gets a list of ShiftDay
description: 'Gets a list of ShiftDay.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
shiftID|Yes|Yes|M1, Macola
shiftDay|Yes|Yes|M1, Macola
startTime|Yes|Yes|M1, Macola
endTime|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_shift-days
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
shiftID[eq]: abc123
shiftDay[eq]: abc123
startTime[eq]: abc123
endTime[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/shifts:
get:
tags:
- View
summary: Gets a list of Shift
description: 'Gets a list of Shift.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
shiftID|Yes|Yes|M1, Macola
shortDesc|Yes|Yes|M1, Macola
inactiveDate|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2.1_view_shifts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
shiftID[eq]: abc123
shortDesc[eq]: abc123
inactiveDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
shiftDays|ShiftDays[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shift'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shift'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/shipment-lines:
get:
tags:
- View
summary: Gets a list of ShipmentLine
description: 'Gets a list of ShipmentLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
shipmentID|Yes|Yes|M1
shipmentLineID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
description|No|Yes|M1
partWarehouseID|Yes|Yes|M1
partBinID|Yes|Yes|M1
invQtyShipped|No|Yes|M1
jobQtyShipped|No|Yes|M1
unitPriceForeign|No|Yes|M1
extendedPriceForeign|No|Yes|M1
isShippedComplete|Yes|Yes|M1
unitOfMeasure|No|Yes|M1
salesOrderID|Yes|Yes|M1
salesOrderLineID|Yes|Yes|M1
salesOrderDeliveryID|Yes|Yes|M1
jobID|Yes|Yes|M1
partGroupID|Yes|Yes|M1
projectID|Yes|Yes|M1'
operationId: GET__api_v2.1_view_shipment-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
shipmentID[eq]: abc123
shipmentLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
isShippedComplete[eq]: true
salesOrderID[eq]: abc123
salesOrderLineID[eq]: abc123
salesOrderDeliveryID[eq]: abc123
jobID[eq]: abc123
partGroupID[eq]: abc123
projectID[eq]: abc123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShipmentLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShipmentLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/tax-codes:
get:
tags:
- View
summary: Gets a list of TaxCode
description: 'Gets a list of TaxCode.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|JobBOSS²
taxCodeID|No|Yes|JobBOSS²
isActive|No|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_tax-codes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
rowVersion[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaxCode'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaxCode'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/timecard-lines:
get:
tags:
- View
summary: Gets a list of TimecardLine
description: 'Gets a list of TimecardLine.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timecardID|Yes|Yes|M1, JobBOSS², Macola
timecardLine|Yes|Yes|M1, JobBOSS², Macola
jobID|Yes|Yes|M1, JobBOSS², Macola
jobAssembly|Yes|Yes|M1, JobBOSS², Macola
jobOperation|Yes|Yes|M1, JobBOSS², Macola
workCenterID|Yes|Yes|M1, JobBOSS², Macola
processID|Yes|Yes|M1, JobBOSS², Macola
status|Yes|Yes|M1, JobBOSS², Macola
timecardType|Yes|Yes|M1, JobBOSS², Macola
goodQty|Yes|Yes|M1, JobBOSS², Macola
scrapQty|Yes|Yes|M1, JobBOSS², Macola
reworkQty|Yes|Yes|M1, JobBOSS², Macola
rejectQty|Yes|Yes|M1, JobBOSS², Macola
startTime|Yes|Yes|M1, JobBOSS², Macola
endTime|Yes|Yes|M1, JobBOSS², Macola
machineHours|Yes|Yes|M1, JobBOSS², Macola
laborHours|Yes|Yes|M1, JobBOSS², Macola
employeeID|Yes|Yes|JobBOSS²
timecardDate|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2.1_view_timecard-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timecardID[eq]: abc123
timecardLine[eq]: abc123
jobID[eq]: abc123
jobAssembly[eq]: abc123
jobOperation[gte]: 123
workCenterID[eq]: abc123
processID[eq]: abc123
status[eq]: abc123
timecardType[eq]: abc123
goodQty[gte]: 123
scrapQty[gte]: 123
reworkQty[gte]: 123
rejectQty[gte]: 123
startTime[gte]: '2020-09-25T04:03:00.0000000'
endTime[gte]: '2020-09-25T04:03:00.0000000'
machineHours[gte]: 123
laborHours[gte]: 123
employeeID[gte]: 123
timecardDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
workCenters|WorkCenters[]|This relationship is obsolete and will be removed in a future release. Use ''workCenter'' instead
workCenter|WorkCenters|The workcenter associated with this line.
timecards|Timecards[]|This relationship is obsolete and will be removed in a future release. Use ''timecard'' instead
timecard|Timecards|The timecard record associated with this line.
jobs|Jobs|This relationship is obsolete and will be removed in a future release. Use ''job'' instead
job|Jobs|The Job associated with this line.
processes|Processes|This relationship is obsolete and will be removed in a future release. Use ''process'' instead
process|Processes|The Process associated with this line.
jobOperations|JobOperations|This relationship is obsolete and will be removed in a future release. Use ''jobOperation'' instead
jobOperationx|JobOperations|The Job Operation associated with this line.
salesOrderDeliveries|SalesOrderDeliveries[]|
salesOrderJobs|SalesOrderJobs|This relationship is obsolete and will be removed in a future release. Use ''salesOrderJob'' instead
salesOrderJob|SalesOrderJobs|The Sales Order Job associated with this line.
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimecardLine_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimecardLine_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/timecards:
get:
tags:
- View
summary: Gets a list of Timecard
description: 'Gets a list of Timecard.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timecardID|Yes|Yes|M1, JobBOSS², Macola, Deacom
employeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom
timecardDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2.1_view_timecards
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timecardID[eq]: abc123
employeeID[eq]: abc123
shiftID[eq]: abc123
timecardDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
timecardlines|Timecardlines[]|
employees|Employees[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Timecard'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Timecard'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/timezones:
get:
tags:
- View
summary: Gets a list of TimeZone
description: 'Gets a list of TimeZone.
## Supported ERPs
- M1
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timeZoneName|Yes|Yes|M1, JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS²
rowVersion|Yes|Yes|M1, JobBOSS²'
operationId: GET__api_v2.1_view_timezones
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timeZoneName[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeZone'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeZone'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/work-center-rate-breaks:
get:
tags:
- View
summary: Gets a list of WorkCenterRateBreak
description: 'Gets a list of WorkCenterRateBreak.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
workCenterID|Yes|Yes|JobBOSS²
shortDesc|Yes|Yes|JobBOSS²
ordinal|Yes|Yes|JobBOSS²
setupRate|Yes|Yes|JobBOSS²
prodRate|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²
laborRate|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_work-center-rate-breaks
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
workCenterID[eq]: abc123
shortDesc[eq]: abc123
ordinal[gte]: 123
setupRate[gte]: 123
prodRate[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
laborRate[eq]: abc123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenterRateBreak'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenterRateBreak'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2.1/view/work-centers:
get:
tags:
- View
summary: Gets a list of WorkCenter
description: 'Gets a list of WorkCenter.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
workCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
deptID|Yes|Yes|M1, JobBOSS², Macola, Deacom
overHeadRate|Yes|Yes|M1, JobBOSS², Macola, Deacom
quoteRate|Yes|Yes|M1, JobBOSS², Macola, Deacom
processID|Yes|Yes|M1, JobBOSS², Macola, Deacom
parentWorkCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
laborRate|Yes|Yes|JobBOSS²'
operationId: GET__api_v2.1_view_work-centers
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
workCenterID[eq]: abc123
shortDesc[eq]: abc123
deptID[eq]: abc123
overHeadRate[eq]: abc123
quoteRate[eq]: abc123
processID[eq]: abc123
parentWorkCenterID[eq]: abc123
shiftID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
laborRate[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
departments|Departments[]|
shifts|Shifts[]|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenter_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenter_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/ap-invoice-lines:
get:
tags:
- View
summary: Gets a list of APInvoiceLine
description: 'Gets a list of APInvoiceLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1
lineID|No|Yes|M1
itemType|No|Yes|M1
partID|No|Yes|M1
partRevisionID|No|Yes|M1
partDescription|No|Yes|M1
purchaseQuantity|No|Yes|M1
baseUnitCost|No|Yes|M1
foreignUnitCost|No|Yes|M1
baseExtendedCost|No|Yes|M1
foreignExtendedCost|No|Yes|M1
baseSetupCharge|No|Yes|M1
foreignSetupCharge|No|Yes|M1
unitOfMeasure|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1'
operationId: GET__api_v2_view_ap-invoice-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoiceLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoiceLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/ap-invoices:
get:
tags:
- View
summary: Gets a list of APInvoice
description: 'Gets a list of APInvoice.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1, Macola
invoiceDate|Yes|Yes|M1, Macola
dueDate|Yes|Yes|M1, Macola
invoiceType|Yes|Yes|M1, Macola
isPostedToGL|Yes|Yes|M1, Macola
postedDate|Yes|Yes|M1, Macola
isOnHold|Yes|Yes|M1, Macola
isOverpayment|No|Yes|M1, Macola
paymentTermID|No|Yes|M1, Macola
baseTotal|No|Yes|M1, Macola
foreignTotal|No|Yes|M1, Macola
baseBalance|No|Yes|M1, Macola
foreignBalance|No|Yes|M1, Macola
uniqueID|No|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
currency|No|Yes|M1, Macola
supplierID|No|Yes|M1, Macola
paidDate|No|Yes|M1, Macola
plantID|No|Yes|M1, Macola'
operationId: GET__api_v2_view_ap-invoices
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
invoiceDate[gte]: '2020-09-25T00:00:00.0000000'
dueDate[gte]: '2020-09-25T00:00:00.0000000'
invoiceType[gte]: 123
isPostedToGL[eq]: true
postedDate[gte]: '2020-09-25T00:00:00.0000000'
isOnHold[eq]: true
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoice'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/APInvoice'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/ar-invoices:
get:
tags:
- View
summary: Gets a list of ARInvoice
description: 'Gets a list of ARInvoice.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1, Macola
invoiceDate|Yes|Yes|M1, Macola
dueDate|Yes|Yes|M1, Macola
invoiceType|Yes|Yes|M1, Macola
isPostedToGL|Yes|Yes|M1, Macola
postedDate|Yes|Yes|M1, Macola
isOnHold|Yes|Yes|M1, Macola
isOverpayment|Yes|Yes|M1, Macola
paymentTermID|Yes|Yes|M1, Macola
invoiceTotalBase|Yes|Yes|M1, Macola
invoiceTotalForeign|No|Yes|M1, Macola
invoiceBalanceBase|No|Yes|M1, Macola
invoiceBalanceForeign|No|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
customerID|No|Yes|M1, Macola
paidDate|No|Yes|M1, Macola
plantID|No|Yes|M1, Macola'
operationId: GET__api_v2_view_ar-invoices
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
invoiceDate[gte]: '2020-09-25T00:00:00.0000000'
dueDate[gte]: '2020-09-25T00:00:00.0000000'
invoiceType[gte]: 123
isPostedToGL[eq]: true
postedDate[gte]: '2020-09-25T00:00:00.0000000'
isOnHold[eq]: true
isOverpayment[eq]: true
paymentTermID[eq]: abc123
invoiceTotalBase[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoice'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoice'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/ar-invoice-sales-people:
get:
tags:
- View
summary: Gets a list of ARInvoiceSalesPerson
description: 'Gets a list of ARInvoiceSalesPerson.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
invoiceID|Yes|Yes|M1, Macola
employeeID|Yes|Yes|M1, Macola
sequenceID|No|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_ar-invoice-sales-people
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
invoiceID[eq]: abc123
employeeID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoiceSalesPerson'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ARInvoiceSalesPerson'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/contacts:
get:
tags:
- View
summary: Gets a list of Contact
description: 'Gets a list of Contact.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
contactID|Yes|Yes|M1, JobBOSS², Macola
name|Yes|Yes|M1, JobBOSS², Macola
organizationID|Yes|Yes|M1, JobBOSS², Macola
organizationTypes|Yes|Yes|JobBOSS²
phoneNumber|Yes|Yes|M1, JobBOSS², Macola
emailAddress|Yes|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
comments|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_contacts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
contactID[eq]: abc123
name[eq]: abc123
organizationID[eq]: abc123
organizationTypes[gte]: 123
phoneNumber[eq]: abc123
emailAddress[eq]: abc123
isActive[eq]: true
comments[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
organization|Organizations|The organization to which the Contact belongs.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Contact'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Contact'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/cycle-codes:
get:
tags:
- View
summary: Gets a list of CycleCode
description: 'Gets a list of CycleCode.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
cycleCodeID|Yes|Yes|M1'
operationId: GET__api_v2_view_cycle-codes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
cycleCodeID[eq]: abc123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CycleCode'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CycleCode'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/departments:
get:
tags:
- View
summary: Gets a list of Department
description: 'Gets a list of Department.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
deptID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2_view_departments
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
deptID[eq]: abc123
shortDesc[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Department'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Department'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/dmr-claim-lines:
get:
tags:
- View
summary: Gets a list of DmrClaimLine
description: 'Gets a list of DmrClaimLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
claimLineID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
partShortDescription|No|Yes|M1
partLongDescription|No|Yes|M1
partWarehouseID|Yes|Yes|M1
quantity|No|Yes|M1
quantityShipped|No|Yes|M1
unitOfMeasure|No|Yes|M1
unitCost|No|Yes|M1
foreignUnitCost|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
claimID|Yes|Yes|M1'
operationId: GET__api_v2_view_dmr-claim-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
claimLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
claimID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
claim|DmrClaims|
part|Parts|
partRevision|PartRevisions|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaimLine_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaimLine_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/dmr-claims:
get:
tags:
- View
summary: Gets a list of DmrClaim
description: 'Gets a list of DmrClaim.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
claimID|Yes|Yes|M1
supplierOrganizationID|Yes|Yes|M1
claimDate|Yes|Yes|M1
claimTotal|No|Yes|M1
foreignTotal|No|Yes|M1
currency|No|Yes|M1
plantID|Yes|Yes|M1
projectID|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
status|No|Yes|M1'
operationId: GET__api_v2_view_dmr-claims
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
claimID[eq]: abc123
supplierOrganizationID[eq]: abc123
claimDate[gte]: '2020-09-25T00:00:00.0000000'
plantID[eq]: abc123
projectID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
supplier|Organizations|
plant|Plants|
project|Projects|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaim'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DmrClaim'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/employees:
get:
tags:
- View
summary: Gets a list of Employee
description: 'Gets a list of Employee.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
employeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom
firstName|Yes|Yes|M1, JobBOSS², Macola, Deacom
lastName|Yes|Yes|M1, JobBOSS², Macola, Deacom
title|Yes|Yes|M1, JobBOSS², Macola, Deacom
supervisorEmployeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom
payRate|Yes|Yes|M1, JobBOSS², Macola, Deacom
deptID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom
isActive|Yes|Yes|JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2_view_employees
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
employeeID[eq]: abc123
firstName[eq]: abc123
lastName[eq]: abc123
title[eq]: abc123
supervisorEmployeeID[eq]: abc123
payRate[gte]: 123
deptID[eq]: abc123
shiftID[eq]: abc123
isActive[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Employee_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Employee_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/gl-codes:
get:
tags:
- View
summary: Gets a list of GLCode
description: 'Gets a list of GLCode.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|JobBOSS²
glCodeID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
isActive|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_gl-codes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
glCodeID[eq]: abc123
rowVersion[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
isActive[eq]: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GLCode'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GLCode'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/inspection-lines:
get:
tags:
- View
summary: Gets a list of InspectionLine
description: 'Gets a list of InspectionLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
notes|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
inspectionID|Yes|Yes|M1
inspectionLineID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
partWarehouseID|Yes|Yes|M1
partBinID|Yes|Yes|M1
quantityToInspect|No|Yes|M1
supplierOrganizationID|Yes|Yes|M1
isInspectionComplete|Yes|Yes|M1
unitCost|No|Yes|M1
projectID|Yes|Yes|M1
projectAreaID|Yes|Yes|M1
inspectionDate|No|Yes|M1
sourceType|Yes|Yes|M1
inspectorEmployeeID|Yes|Yes|M1'
operationId: GET__api_v2_view_inspection-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
inspectionID[eq]: abc123
inspectionLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
supplierOrganizationID[eq]: abc123
isInspectionComplete[eq]: true
projectID[eq]: abc123
projectAreaID[eq]: abc123
sourceType[gte]: 123
inspectorEmployeeID[eq]: abc123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/InspectionLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/InspectionLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/job-assemblies:
get:
tags:
- View
summary: Gets a list of JobAssembly
description: 'Gets a list of JobAssembly.
## Supported ERPs
- M1
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|M1, Deacom
jobAssemblyID|Yes|Yes|M1, Deacom
level|No|Yes|M1, Deacom
parentAssemblyID|No|Yes|M1, Deacom
sourceMethodID|No|Yes|M1, Deacom
sourceRevisionID|No|Yes|M1, Deacom
partID|Yes|Yes|M1, Deacom
partRevisionID|Yes|Yes|M1, Deacom
partShortDesc|No|Yes|M1, Deacom
quantityPerParent|No|Yes|M1, Deacom
orderQty|No|Yes|M1, Deacom
inventoryQty|No|Yes|M1, Deacom
scrapQty|No|Yes|M1, Deacom
quantityToInspect|No|Yes|M1, Deacom
quantityRcvdToInv|No|Yes|M1, Deacom
productionQty|No|Yes|M1, Deacom
quantityToMake|No|Yes|M1, Deacom
quantityToPull|No|Yes|M1, Deacom
quantityIssued|No|Yes|M1, Deacom
quantityCompleted|No|Yes|M1, Deacom
isProductionComplete|No|Yes|M1, Deacom
completedDate|No|Yes|M1, Deacom
uniqueID|Yes|Yes|M1, Deacom
rowVersion|Yes|Yes|M1, Deacom
jobIsClosed|Yes|Yes|M1, Deacom
jobClosedDate|Yes|Yes|M1, Deacom'
operationId: GET__api_v2_view_job-assemblies
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssemblyID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
jobIsClosed[eq]: true
jobClosedDate[gte]: '2020-09-25T04:03:00.0000000'
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobAssembly'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobAssembly'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/job-materials:
get:
tags:
- View
summary: Gets a list of JobMaterial
description: 'Gets a list of JobMaterial.
## Supported ERPs
- JobBOSS²
- M1
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|JobBOSS², M1, Deacom
jobAssemblyID|Yes|Yes|JobBOSS², M1, Deacom
jobAssemblySeq|No|Yes|M1
materialPartID|Yes|Yes|JobBOSS², M1, Deacom
materialPartRevisionID|Yes|Yes|JobBOSS², M1, Deacom
estQuantity|No|Yes|JobBOSS², M1, Deacom
estUnitCost|No|Yes|JobBOSS², M1, Deacom
unitOfMeasure|No|Yes|JobBOSS², M1, Deacom
leadTime|No|Yes|JobBOSS², M1, Deacom
vendorID|Yes|Yes|JobBOSS², M1, Deacom
uniqueID|Yes|Yes|JobBOSS², M1, Deacom
rowVersion|Yes|Yes|JobBOSS², M1, Deacom
jobIsClosed|Yes|Yes|JobBOSS², M1, Deacom
jobClosedDate|Yes|Yes|JobBOSS², M1, Deacom
jobType|Yes|Yes|Deacom'
operationId: GET__api_v2_view_job-materials
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssemblyID[eq]: abc123
materialPartID[eq]: abc123
materialPartRevisionID[eq]: abc123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
jobIsClosed[eq]: true
jobClosedDate[gte]: '2020-09-25T04:03:00.0000000'
jobType[eq]: abc123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobMaterial'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobMaterial'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/job-operations:
get:
tags:
- View
summary: Gets a list of JobOperation
description: 'Gets a list of JobOperation.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobAssembly|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobOperationSeq|Yes|Yes|M1, JobBOSS², Macola, Deacom
status|Yes|Yes|M1, JobBOSS², Macola, Deacom
workCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
processID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescFormatted|No|Yes|M1, JobBOSS², Macola, Deacom
outsideOperation|Yes|Yes|M1, JobBOSS², Macola, Deacom
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
schedStartDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
schedEndDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
actStartDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
actEndDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupHours|No|Yes|M1, JobBOSS², Macola, Deacom
estProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQueueHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estMoveHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
actSetupHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
actualProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
actQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
vendorID|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupTimeValue|No|Yes|JobBOSS²
estSetupTimeUnit|No|Yes|JobBOSS²
estProdTimeValue|No|Yes|JobBOSS²
estProdTimeUnit|No|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
operationQty|No|Yes|M1, JobBOSS², Macola, Deacom
quantityComplete|No|Yes|M1, JobBOSS², Macola, Deacom
isSetupComplete|No|Yes|M1, JobBOSS², Macola, Deacom
plantID|No|Yes|M1, JobBOSS², Macola, Deacom
purchaseOrderID|No|Yes|M1, JobBOSS², Macola, Deacom
supplierOrganizationID|No|Yes|M1, JobBOSS², Macola, Deacom
purchaseLocationID|No|Yes|M1, JobBOSS², Macola, Deacom
RFQID|No|Yes|M1, JobBOSS², Macola, Deacom
defaultEmployeeID|Yes|Yes|JobBOSS²
defaultEmployeeID2|Yes|Yes|JobBOSS²
defaultEmployeeID3|Yes|Yes|JobBOSS²
isUnattended|No|Yes|JobBOSS²
jobType|Yes|Yes|Deacom
supplierLeadTime|No|Yes|JobBOSS²
jobIsClosed|Yes|Yes|JobBOSS², M1, Deacom
jobClosedDate|Yes|Yes|JobBOSS², M1, Deacom'
operationId: GET__api_v2_view_job-operations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
jobAssembly[eq]: abc123
jobOperationSeq[gte]: 123
status[eq]: abc123
workCenterID[eq]: abc123
processID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
outsideOperation[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
schedStartDate[gte]: '2020-09-25T04:03:00.0000000'
schedEndDate[gte]: '2020-09-25T04:03:00.0000000'
actStartDate[gte]: '2020-09-25T04:03:00.0000000'
actEndDate[gte]: '2020-09-25T04:03:00.0000000'
estProdHours[gte]: 123
estQueueHours[gte]: 123
estMoveHours[gte]: 123
estQAHours[gte]: 123
actSetupHours[gte]: 123
actualProdHours[gte]: 123
actQAHours[gte]: 123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
defaultEmployeeID[eq]: abc123
defaultEmployeeID2[eq]: abc123
defaultEmployeeID3[eq]: abc123
jobType[eq]: abc123
jobIsClosed[eq]: true
jobClosedDate[gte]: '2020-09-25T04:03:00.0000000'
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobOperation_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobOperation_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/jobs:
get:
tags:
- View
summary: Gets a list of Job
description: 'Gets a list of Job.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
jobID|Yes|Yes|M1, JobBOSS², Macola, Deacom
customerID|No|Yes|M1, JobBOSS², Macola, Deacom
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
orderQty|No|Yes|M1, JobBOSS², Macola, Deacom
prodQty|No|Yes|M1, JobBOSS², Macola, Deacom
schedStartDate|No|Yes|M1, JobBOSS², Macola, Deacom
schedEndDate|No|Yes|M1, JobBOSS², Macola, Deacom
estLeadTime|No|Yes|M1, JobBOSS², Macola, Deacom
actStartDate|No|Yes|M1, JobBOSS², Macola, Deacom
actEndDate|No|Yes|M1, JobBOSS², Macola, Deacom
dueDate|No|Yes|M1, JobBOSS², Macola, Deacom
status|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobCost|No|Yes|M1, JobBOSS², Macola, Deacom
jobCostForeign|No|Yes|M1, JobBOSS², Macola, Deacom
plantID|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
partWarehouseID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partBinID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partShortDesc|No|Yes|M1, JobBOSS², Macola, Deacom
inventoryQty|No|Yes|M1, JobBOSS², Macola, Deacom
isPlanningComplete|Yes|Yes|M1, JobBOSS², Macola, Deacom
isScheduleComplete|Yes|Yes|M1, JobBOSS², Macola, Deacom
isReleasedToFloor|Yes|Yes|M1, JobBOSS², Macola, Deacom
isOnHold|Yes|Yes|M1, JobBOSS², Macola, Deacom
completedDate|No|Yes|M1, JobBOSS², Macola, Deacom
quantityCompleted|No|Yes|M1, JobBOSS², Macola, Deacom
quantityShipped|No|Yes|M1, JobBOSS², Macola, Deacom
quantityRcvdToInventory|No|Yes|M1, JobBOSS², Macola, Deacom
projectID|Yes|Yes|M1, JobBOSS², Macola, Deacom
projectAreaID|Yes|Yes|M1, JobBOSS², Macola, Deacom
isClosed|Yes|Yes|M1, JobBOSS², Macola, Deacom
closedDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
jobPriorityID|Yes|Yes|M1, JobBOSS², Macola, Deacom
unitOfMeasure|No|Yes|M1, JobBOSS², Macola, Deacom
plannerEmployeeID|No|Yes|M1, JobBOSS², Macola, Deacom
parentJobID|Yes|Yes|JobBOSS²
shortDesc|No|Yes|Deacom
childJobID|No|Yes|Deacom
jobType|Yes|Yes|Deacom'
operationId: GET__api_v2_view_jobs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
jobID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
status[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
plantID[eq]: abc123
jobDate[gte]: '2020-09-25T04:03:00.0000000'
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
isPlanningComplete[eq]: true
isScheduleComplete[eq]: true
isReleasedToFloor[eq]: true
isOnHold[eq]: true
projectID[eq]: abc123
projectAreaID[eq]: abc123
isClosed[eq]: true
closedDate[gte]: '2020-09-25T04:03:00.0000000'
jobPriorityID[eq]: abc123
parentJobID[eq]: abc123
jobType[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
jobOperations|JobOperations[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Job_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Job_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/locations:
get:
tags:
- View
summary: Gets a list of Location
description: 'Gets a list of Location.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
locationID|Yes|Yes|M1, JobBOSS², Macola
name|Yes|Yes|M1, JobBOSS², Macola
organizationID|Yes|Yes|M1, JobBOSS², Macola
organizationTypes|Yes|Yes|JobBOSS²
addressLine1|No|Yes|M1, JobBOSS², Macola
addressLine2|No|Yes|M1, JobBOSS², Macola
addressLine3|No|Yes|M1, JobBOSS², Macola
city|Yes|Yes|M1, JobBOSS², Macola
county|Yes|Yes|M1, JobBOSS², Macola
country|Yes|Yes|M1, JobBOSS², Macola
postalCode|Yes|Yes|M1, JobBOSS², Macola
state|Yes|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
locationTypes|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_locations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
locationID[eq]: abc123
name[eq]: abc123
organizationID[eq]: abc123
organizationTypes[gte]: 123
city[eq]: abc123
county[eq]: abc123
country[eq]: abc123
postalCode[eq]: abc123
state[eq]: abc123
isActive[eq]: true
locationTypes[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
organization|Organizations|The organization to which the Location belongs.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Location'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Location'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/organization-parts:
get:
tags:
- View
summary: Gets a list of OrganizationPart
description: 'Gets a list of OrganizationPart.
## Supported ERPs
- JobBOSS²
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|JobBOSS², M1
partRevisionID|Yes|Yes|JobBOSS², M1
organizationID|Yes|Yes|JobBOSS², M1
organizationTypes|Yes|Yes|JobBOSS²
organizationPartID|Yes|Yes|JobBOSS², M1
organizationShortDesc|No|Yes|JobBOSS², M1
uniqueID|Yes|Yes|JobBOSS², M1
rowVersion|Yes|Yes|JobBOSS², M1'
operationId: GET__api_v2_view_organization-parts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
organizationID[eq]: abc123
organizationTypes[gte]: 123
organizationPartID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OrganizationPart'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OrganizationPart'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/organizations:
get:
tags:
- View
summary: Gets a list of Organization
description: 'Gets a list of Organization.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
name|Yes|Yes|M1, JobBOSS², Macola
organizationID|Yes|Yes|M1, JobBOSS², Macola
country|Yes|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
organizationTypes|Yes|Yes|JobBOSS², Macola
phoneNumber|Yes|Yes|JobBOSS²
customerPaymentTermID|Yes|Yes|JobBOSS²
customerTaxCodeID|Yes|Yes|JobBOSS²
supplierPaymentTermID|Yes|Yes|JobBOSS²
supplierTaxCodeID|Yes|Yes|JobBOSS²
currencyCode|Yes|Yes|JobBOSS²
websiteUrl|No|Yes|JobBOSS²
comments|No|Yes|JobBOSS²
salesAccountID|Yes|Yes|JobBOSS²
leadTimeDays|No|Yes|JobBOSS²
minimumOrderAmount|No|Yes|JobBOSS²
customerStatus|Yes|Yes|M1
supplierStatus|Yes|Yes|M1'
operationId: GET__api_v2_view_organizations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
name[eq]: abc123
organizationID[eq]: abc123
country[eq]: abc123
isActive[eq]: true
organizationTypes[gte]: 123
phoneNumber[eq]: abc123
customerPaymentTermID[eq]: abc123
customerTaxCodeID[eq]: abc123
supplierPaymentTermID[eq]: abc123
supplierTaxCodeID[eq]: abc123
currencyCode[eq]: abc123
salesAccountID[eq]: abc123
customerStatus[gte]: 123
supplierStatus[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Organization'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Organization'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-bins:
get:
tags:
- View
summary: Gets a list of PartBin
description: 'Gets a list of PartBin.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partRevisionID|Yes|Yes|M1, JobBOSS², Deacom
warehouseID|Yes|Yes|M1, JobBOSS², Deacom
partBinID|Yes|Yes|M1, JobBOSS², Deacom
quantityOnHand|No|Yes|M1, JobBOSS², Deacom
quantityAllocated|No|Yes|M1, JobBOSS², Deacom
quantityOnOrderSales|No|Yes|M1, JobBOSS², Deacom
quantityOnOrderPurchases|No|Yes|M1, JobBOSS², Deacom
quantityToInspect|No|Yes|M1, JobBOSS², Deacom
quantityToReturn|No|Yes|M1, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
partID|Yes|Yes|M1, JobBOSS², Deacom
lotNumber|Yes|Yes|JobBOSS²
purchaseOrderLineID|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_part-bins
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partRevisionID[eq]: abc123
warehouseID[eq]: abc123
partBinID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
partID[eq]: abc123
lotNumber[eq]: abc123
purchaseOrderLineID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
partRevision|PartRevisions|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartBin_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartBin_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-classes:
get:
tags:
- View
summary: Gets a list of PartClass
description: 'Gets a list of PartClass.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
partClassID|No|Yes|M1
isActive|Yes|Yes|M1'
operationId: GET__api_v2_view_part-classes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isActive[eq]: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartClass'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartClass'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-cost-breaks:
get:
tags:
- View
summary: Gets a list of PartCostBreak
description: 'Gets a list of PartCostBreak.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partCostID|Yes|Yes|JobBOSS²
quantity|No|Yes|JobBOSS²
unitCost|No|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_part-cost-breaks
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partCostID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartCostBreak'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartCostBreak'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-costs:
get:
tags:
- View
summary: Gets a list of PartRevision
description: 'Gets a list of PartRevision.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partCostID|Yes|Yes|JobBOSS²
partID|Yes|Yes|JobBOSS²
partRevisionID|Yes|Yes|JobBOSS²
startDate|Yes|Yes|JobBOSS²
endDate|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_part-costs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partCostID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
startDate[gte]: '2020-09-25T04:03:00.0000000'
endDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-groups:
get:
tags:
- View
summary: Gets a list of PartGroup
description: 'Gets a list of PartGroup.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
partGroupID|Yes|Yes|M1, JobBOSS², Macola
parentPartGroupID|Yes|Yes|M1, JobBOSS², Macola
description|No|Yes|M1, JobBOSS², Macola
isActive|Yes|Yes|M1, JobBOSS², Macola
inactiveDate|No|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2_view_part-groups
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
partGroupID[eq]: abc123
parentPartGroupID[eq]: abc123
isActive[eq]: true
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartGroup'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartGroup'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-materials:
get:
tags:
- View
summary: Gets a list of PartMaterial
description: 'Gets a list of PartMaterial.
## Supported ERPs
- JobBOSS²
- M1
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|JobBOSS², M1, Deacom
partRevisionID|Yes|Yes|JobBOSS², M1, Deacom
partOperationSeq|Yes|Yes|JobBOSS², M1, Deacom
materialPartID|Yes|Yes|JobBOSS², M1, Deacom
materialPartRevisionID|Yes|Yes|JobBOSS², M1, Deacom
uniqueID|Yes|Yes|JobBOSS², M1, Deacom
rowVersion|Yes|Yes|JobBOSS², M1, Deacom
quantity|No|Yes|JobBOSS², M1, Deacom
unitOfMeasure|No|Yes|JobBOSS², M1, Deacom
partAssemblyID|No|Yes|M1
partAssemblySeq|No|Yes|M1'
operationId: GET__api_v2_view_part-materials
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
partOperationSeq[gte]: 123
materialPartID[eq]: abc123
materialPartRevisionID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartMaterial'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartMaterial'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-operations:
get:
tags:
- View
summary: Gets a list of PartOperation
description: 'Gets a list of PartOperation.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partOperationSeq|Yes|Yes|M1, JobBOSS², Macola, Deacom
workCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
processID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescFormatted|Yes|Yes|M1, JobBOSS², Macola, Deacom
outsideOperation|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQueueHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estMoveHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
estQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom
vendorID|Yes|Yes|M1, JobBOSS², Macola, Deacom
estSetupTimeValue|No|Yes|JobBOSS²
estSetupTimeUnit|No|Yes|JobBOSS²
estProdTimeValue|No|Yes|JobBOSS²
estProdTimeUnit|No|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2_view_part-operations
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
partOperationSeq[gte]: 123
workCenterID[eq]: abc123
processID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
longDescFormatted[eq]: abc123
outsideOperation[eq]: abc123
estSetupHours[gte]: 123
estProdHours[gte]: 123
estQueueHours[gte]: 123
estMoveHours[gte]: 123
estQAHours[gte]: 123
vendorID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartOperation_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartOperation_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-price-breaks:
get:
tags:
- View
summary: Gets a list of PartPriceBreak
description: 'Gets a list of PartPriceBreak.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partPriceID|Yes|Yes|JobBOSS²
quantity|No|Yes|JobBOSS²
unitPrice|No|Yes|JobBOSS²
markup|No|Yes|JobBOSS²
discount|No|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_part-price-breaks
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partPriceID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPriceBreak'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPriceBreak'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-prices:
get:
tags:
- View
summary: Gets a list of PartPrice
description: 'Gets a list of PartPrice.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partPriceID|Yes|Yes|JobBOSS²
partID|Yes|Yes|JobBOSS²
partRevisionID|Yes|Yes|JobBOSS²
startDate|Yes|Yes|JobBOSS²
endDate|Yes|Yes|JobBOSS²
isCustomerSpecific|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_part-prices
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partPriceID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
startDate[gte]: '2020-09-25T04:03:00.0000000'
endDate[gte]: '2020-09-25T04:03:00.0000000'
isCustomerSpecific[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPrice'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartPrice'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-revisions:
get:
tags:
- View
summary: Gets a list of PartRevision
description: 'Gets a list of PartRevision.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partID|Yes|Yes|M1, JobBOSS², Macola, Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom
longDescFormatted|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
partCost|No|Yes|M1, JobBOSS², Macola, Deacom
effectiveStartDate|No|Yes|JobBOSS²
expirationEndDate|No|Yes|JobBOSS²
supplierOrganizationID|No|Yes|JobBOSS²
leadTime|No|Yes|JobBOSS²
quantityOnHand|No|Yes|JobBOSS²
pricingUnitOfMeasure|No|Yes|JobBOSS²'
operationId: GET__api_v2_view_part-revisions
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partID[eq]: abc123
partRevisionID[eq]: abc123
shortDesc[eq]: abc123
longDescText[eq]: abc123
longDescFormatted[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartRevision_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/parts:
get:
tags:
- View
summary: Gets a list of Part
description: 'Gets a list of Part.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partClassID|No|Yes|M1, JobBOSS², Deacom
partGroupID|Yes|Yes|M1, JobBOSS², Deacom
cycleCodeID|No|Yes|M1, JobBOSS², Deacom
partType|Yes|Yes|M1, JobBOSS², Deacom
partID|Yes|Yes|M1, JobBOSS², Deacom
alternatePartID|No|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
isActive|Yes|Yes|M1, JobBOSS², Deacom'
operationId: GET__api_v2_view_parts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partGroupID[eq]: abc123
partType[gte]: 123
partID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isActive[eq]: true
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
partClass|PartClasses|
partGroup|PartGroups|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Part'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Part'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/part-transactions:
get:
tags:
- View
summary: Gets a list of PartTransaction
description: 'Gets a list of PartTransaction.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
partTransactionID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
transactionType|Yes|Yes|M1
source|Yes|Yes|M1
receiptType|Yes|Yes|M1
isNonInventoryTransaction|No|Yes|M1
purchaseOrderID|Yes|Yes|M1
jobID|Yes|Yes|M1
partWarehouseID|Yes|Yes|M1
partBinID|Yes|Yes|M1
supplierOrganizationID|Yes|Yes|M1
inventoryQtyRcvd|No|Yes|M1
scrapQty|No|Yes|M1
quantityToInspect|No|Yes|M1
quantityToReturn|No|Yes|M1
purchaseQtyRcvd|No|Yes|M1
purchaseUnitCost|No|Yes|M1
transactionDate|Yes|Yes|M1
reference|No|Yes|M1
shipmentID|No|Yes|M1
shipmentLineID|No|Yes|M1
receiptID|No|Yes|M1
DMRShipmentID|No|Yes|M1
RMAReceiptID|No|Yes|M1
inspectionID|No|Yes|M1
inventoryCountID|No|Yes|M1
warehouseTransferID|No|Yes|M1
warehouseReceiptID|No|Yes|M1
projectID|No|Yes|M1
projectAreaID|No|Yes|M1
plantID|No|Yes|M1
costType|No|Yes|M1
quantity|No|Yes|M1
unitLaborCost|No|Yes|M1
unitOverheadCost|No|Yes|M1
unitMaterialCost|No|Yes|M1
unitSubcontractCost|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1'
operationId: GET__api_v2_view_part-transactions
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
partTransactionID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
transactionType[gte]: 123
source[gte]: 123
receiptType[gte]: 123
purchaseOrderID[eq]: abc123
jobID[eq]: abc123
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
supplierOrganizationID[eq]: abc123
transactionDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartTransaction'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PartTransaction'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/payment-terms:
get:
tags:
- View
summary: Gets a list of PaymentTerm
description: 'Gets a list of PaymentTerm.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1, JobBOSS², Macola
paymentTermID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola
uniqueID|Yes|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2_view_payment-terms
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
paymentTermID[eq]: abc123
rowVersion[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentTerm'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentTerm'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/plants:
get:
tags:
- View
summary: Gets a list of Plant
description: 'Gets a list of Plant.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
plantID|Yes|Yes|M1, Macola
name|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_plants
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
plantID[eq]: abc123
name[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Plant'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Plant'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/processes:
get:
tags:
- View
summary: Gets a list of Process
description: 'Gets a list of Process.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
processID|Yes|Yes|M1, Macola
shortDesc|Yes|Yes|M1, Macola
setupRate|Yes|Yes|M1, Macola
productionRate|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_processes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
processID[eq]: abc123
shortDesc[eq]: abc123
setupRate[eq]: abc123
productionRate[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Process'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Process'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/production-calendars:
get:
tags:
- View
summary: Gets a list of ProductionCalendar
description: 'Gets a list of ProductionCalendar.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
productionDate|Yes|Yes|M1, Macola
productionHours|Yes|Yes|M1, Macola
productionStartTime|Yes|Yes|M1, Macola
workCenterID|Yes|Yes|M1, Macola
plantID|Yes|Yes|M1, Macola
department|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_production-calendars
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
productionDate[gte]: '2020-09-25T04:03:00.0000000'
productionHours[gte]: 123
productionStartTime[eq]: abc123
workCenterID[eq]: abc123
plantID[eq]: abc123
department[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductionCalendar'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductionCalendar'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/projects:
get:
tags:
- View
summary: Gets a list of Project
description: 'Gets a list of Project.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
projectID|Yes|Yes|M1, Macola
customerID|Yes|Yes|M1, Macola
locationID|No|Yes|M1, Macola
contactID|No|Yes|M1, Macola
dueDate|No|Yes|M1, Macola
projectDate|Yes|Yes|M1, Macola
closedDate|No|Yes|M1, Macola
shortDescription|No|Yes|M1, Macola
longDescription|No|Yes|M1, Macola
statusCode|No|Yes|M1, Macola
isClosed|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_projects
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
projectID[eq]: abc123
customerID[eq]: abc123
projectDate[gte]: '2020-09-25T00:00:00.0000000'
isClosed[eq]: true
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|The Customer Organization.
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Project'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Project'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/purchase-order-lines:
get:
tags:
- View
summary: Gets a list of PurchaseOrderLine
description: 'Gets a list of PurchaseOrderLine.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
dueDate|Yes|Yes|M1, JobBOSS², Deacom
extendedCost|No|Yes|M1, JobBOSS², Deacom
foreignExtendedCost|No|Yes|M1, JobBOSS², Deacom
partID|Yes|Yes|M1, JobBOSS², Deacom
partRevisionID|Yes|Yes|M1, JobBOSS², Deacom
partDescription|No|Yes|M1, JobBOSS², Deacom
partWarehouse|No|Yes|M1, JobBOSS², Deacom
purchaseOrderLineID|Yes|Yes|M1, JobBOSS², Deacom
quantity|No|Yes|M1, JobBOSS², Deacom
quantityReceived|No|Yes|M1, JobBOSS², Deacom
unitCost|No|Yes|M1, JobBOSS², Deacom
foreignUnitCost|No|Yes|M1, JobBOSS², Deacom
isReceived|Yes|Yes|M1, JobBOSS², Deacom
inspectionRequired|Yes|Yes|M1, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
isClosed|Yes|Yes|M1, JobBOSS², Deacom
purchaseOrderID|Yes|Yes|M1, JobBOSS², Deacom
unitOfMeasure|No|Yes|JobBOSS², Deacom
jobID|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_purchase-order-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
dueDate[gte]: '2020-09-25T00:00:00.0000000'
partID[eq]: abc123
partRevisionID[eq]: abc123
purchaseOrderLineID[eq]: abc123
isReceived[eq]: true
inspectionRequired[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isClosed[eq]: true
purchaseOrderID[eq]: abc123
jobID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
purchaseOrder|PurchaseOrders|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrderLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrderLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/purchase-orders:
get:
tags:
- View
summary: Gets a list of PurchaseOrder
description: 'Gets a list of PurchaseOrder.
## Supported ERPs
- M1
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
apInvoiceLocationID|No|Yes|M1, JobBOSS², Deacom
buyerEmployeeID|No|Yes|M1, JobBOSS², Deacom
currency|No|Yes|M1, JobBOSS², Deacom
orderDate|Yes|Yes|M1, JobBOSS², Deacom
plantID|Yes|Yes|M1, JobBOSS², Deacom
projectID|Yes|Yes|M1, JobBOSS², Deacom
purchaseOrderID|Yes|Yes|M1, JobBOSS², Deacom
supplierOrganizationID|Yes|Yes|M1, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Deacom
isClosed|Yes|Yes|M1, JobBOSS², Deacom'
operationId: GET__api_v2_view_purchase-orders
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
orderDate[gte]: '2020-09-25T00:00:00.0000000'
plantID[eq]: abc123
projectID[eq]: abc123
purchaseOrderID[eq]: abc123
supplierOrganizationID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isClosed[eq]: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/quote-lines:
get:
tags:
- View
summary: Gets a list of QuoteLine
description: 'Gets a list of QuoteLine.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²
quoteID|Yes|Yes|M1, Macola, JobBOSS²
partID|Yes|Yes|M1, Macola, JobBOSS²
partRevisionID|Yes|Yes|M1, Macola, JobBOSS²
partGroupID|Yes|Yes|M1, Macola, JobBOSS²
shortDescription|No|Yes|M1, Macola, JobBOSS²
quoteQuantityID|No|Yes|M1, Macola, JobBOSS²
quoteLineID|Yes|Yes|M1, Macola, JobBOSS²
resolutionReasonID|No|Yes|M1, Macola, JobBOSS²
locationID|No|Yes|Macola'
operationId: GET__api_v2_view_quote-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
quoteID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partGroupID[eq]: abc123
quoteLineID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
quote|Quotes|The parent Quote header for this line.
resolutionReason|Reasons|The reason detail for the resolution.
partGroup|PartGroups|The parent Quote header for this line.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/quote-quantities:
get:
tags:
- View
summary: Provides a breakdown of pricing for quote line items based on any included…
description: 'Gets a list of QuoteQuantity.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²
quoteQuantityID|Yes|Yes|M1, Macola, JobBOSS²
quoteID|Yes|Yes|M1, Macola, JobBOSS²
quoteLineID|Yes|Yes|M1, Macola, JobBOSS²
quantity|No|Yes|M1, Macola, JobBOSS²
baseUnitPrice|No|Yes|M1, Macola, JobBOSS²
foreignUnitPrice|No|Yes|M1, Macola, JobBOSS²'
operationId: GET__api_v2_view_quote-quantities
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
quoteQuantityID[eq]: abc123
quoteID[eq]: abc123
quoteLineID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
quote|Quotes|The parent Quote header for this line.
quoteLine|QuoteLines|The relaed quote line.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteQuantity'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteQuantity'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/quotes:
get:
tags:
- View
summary: Gets a list of Quote
description: 'Gets a list of Quote.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²
quoteID|Yes|Yes|M1, Macola, JobBOSS²
employeeID|Yes|Yes|M1, Macola, JobBOSS²
organizationID|Yes|Yes|M1, Macola, JobBOSS²
locationID|Yes|Yes|M1, Macola, JobBOSS²
contactID|No|Yes|M1, Macola, JobBOSS²
invoiceLocationID|No|Yes|M1, Macola, JobBOSS²
quoteDate|Yes|Yes|M1, Macola, JobBOSS²
dueDate|No|Yes|M1, Macola, JobBOSS²
isClosed|Yes|Yes|M1, Macola, JobBOSS²
closedDate|Yes|Yes|M1, Macola, JobBOSS²
currencyRateID|No|Yes|M1, Macola, JobBOSS²
customerID|Yes|Yes|M1, Macola, JobBOSS²
expirationDate|Yes|Yes|M1, Macola, JobBOSS²
plantID|No|Yes|M1, Macola, JobBOSS²
projectID|No|Yes|M1, Macola, JobBOSS²
shipToOrganizationID|No|Yes|M1, Macola, JobBOSS²
shipToContactID|No|Yes|M1, Macola, JobBOSS²
shipToLocationID|No|Yes|M1, Macola, JobBOSS²
statusCode|No|Yes|M1, Macola, JobBOSS²
totalSalesAmount|No|Yes|Macola
awardProbability|No|Yes|Macola
lostSaleCode|No|Yes|Macola'
operationId: GET__api_v2_view_quotes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
quoteID[eq]: abc123
employeeID[eq]: abc123
organizationID[eq]: abc123
locationID[eq]: abc123
quoteDate[gte]: '2020-09-25T00:00:00.0000000'
isClosed[eq]: true
closedDate[gte]: '2020-09-25T00:00:00.0000000'
customerID[eq]: abc123
expirationDate[gte]: '2020-09-25T00:00:00.0000000'
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|The Customer Organization.
contact|Contacts|The Customer Contact record.
shipTo|Organizations|The Ship To Organization.
shipToContact|Contacts|The Ship To Contact record.
project|Projects|The Project record for this quote.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Quote'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Quote'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/quote-sales-people:
get:
tags:
- View
summary: Gets a list of QuoteSalesPerson
description: 'Gets a list of QuoteSalesPerson.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
quoteID|Yes|Yes|M1, Macola
employeeID|Yes|Yes|M1, Macola
percentage|No|Yes|M1, Macola
isClosed|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
sequenceNo|No|Yes|Macola'
operationId: GET__api_v2_view_quote-sales-people
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
quoteID[eq]: abc123
employeeID[eq]: abc123
isClosed[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
quote|Quotes|The parent Quote header for this line.
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteSalesPerson'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/QuoteSalesPerson'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/reasons:
get:
tags:
- View
summary: Gets a list of Reason
description: 'Gets a list of Reason.
## Supported ERPs
- M1
- Macola
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
reasonID|Yes|Yes|M1, Macola, JobBOSS²
description|No|Yes|M1, Macola, JobBOSS²
name|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, Macola, JobBOSS²
rowVersion|Yes|Yes|M1, Macola, JobBOSS²'
operationId: GET__api_v2_view_reasons
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
reasonID[eq]: abc123
name[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Reason'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Reason'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/rma-claim-lines:
get:
tags:
- View
summary: Gets a list of RmaClaimLine
description: 'Gets a list of RmaClaimLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
unitPrice|No|Yes|M1
foreignUnitPrice|No|Yes|M1
extendedPrice|No|Yes|M1
foreignExtendedPrice|No|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
claimID|Yes|Yes|M1
claimLineID|Yes|Yes|M1
quantity|No|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1'
operationId: GET__api_v2_view_rma-claim-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
claimID[eq]: abc123
claimLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
claim|RmaClaims|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaimLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaimLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/rma-claims:
get:
tags:
- View
summary: Gets a list of RmaClaim
description: 'Gets a list of RmaClaim.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
claimDate|Yes|Yes|M1
claimTotal|Yes|Yes|M1
foreignTotal|Yes|Yes|M1
currency|No|Yes|M1
customerOrganizationID|Yes|Yes|M1
plantID|Yes|Yes|M1
claimID|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
status|Yes|Yes|M1'
operationId: GET__api_v2_view_rma-claims
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
claimDate[gte]: '2020-09-25T00:00:00.0000000'
claimTotal[gte]: 123
foreignTotal[gte]: 123
customerOrganizationID[eq]: abc123
plantID[eq]: abc123
claimID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
status[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaim'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaClaim'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/rma-receipt-lines:
get:
tags:
- View
summary: Gets a list of RmaReceiptLine
description: 'Gets a list of RmaReceiptLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|M1
isInspected|Yes|Yes|M1
partID|Yes|Yes|M1
partLongDescription|No|Yes|M1
partRevisionID|Yes|Yes|M1
partWarehouseID|Yes|Yes|M1
projectID|Yes|Yes|M1
isReceived|Yes|Yes|M1
inspectionRequired|Yes|Yes|M1
claimLineID|Yes|Yes|M1
claimQuantity|Yes|Yes|M1
receiptID|Yes|Yes|M1
receiptLineID|Yes|Yes|M1
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
isClosed|Yes|Yes|M1
isReversed|Yes|Yes|M1
claimID|Yes|Yes|M1'
operationId: GET__api_v2_view_rma-receipt-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
isInspected[eq]: true
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
projectID[eq]: abc123
isReceived[eq]: true
inspectionRequired[eq]: true
claimLineID[eq]: abc123
claimQuantity[gte]: 123
receiptID[eq]: abc123
receiptLineID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
isClosed[eq]: true
isReversed[eq]: true
claimID[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
claim|RmaClaims|
claimLine|RmaClaimLines|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaReceiptLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RmaReceiptLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/sales-accounts:
get:
tags:
- View
summary: Gets a list of SalesAccount
description: 'Gets a list of SalesAccount.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesAccountID|Yes|Yes|JobBOSS²
name|Yes|Yes|JobBOSS²
isActive|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_sales-accounts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesAccountID[eq]: abc123
name[eq]: abc123
isActive[eq]: true
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesAccount'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesAccount'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/sales-order-deliveries:
get:
tags:
- View
summary: Gets a list of SalesOrderDelivery
description: 'Gets a list of SalesOrderDelivery.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, Macola
orderLine|Yes|Yes|M1, Macola
orderLineDelivery|Yes|Yes|M1, Macola
promisedDate|Yes|Yes|M1, Macola
promisedQty|Yes|Yes|M1, Macola
shippedDate|Yes|Yes|M1, Macola
shippedQty|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
deliveryTypeCode|No|Yes|M1, Macola
salesOrderType|No|Yes|Macola'
operationId: GET__api_v2_view_sales-order-deliveries
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
orderLineDelivery[eq]: abc123
promisedDate[gte]: '2020-09-25T04:03:00.0000000'
promisedQty[gte]: 123
shippedDate[gte]: '2020-09-25T04:03:00.0000000'
shippedQty[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrderJobs|SalesOrderJobs[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/sales-order-jobs:
get:
tags:
- View
summary: Gets a list of SalesOrderJob
description: 'Gets a list of SalesOrderJob.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, JobBOSS², Macola
orderLine|Yes|Yes|M1, JobBOSS², Macola
orderLineDelivery|Yes|Yes|M1, JobBOSS², Macola
jobID|Yes|Yes|M1, JobBOSS², Macola
orderJobSeq|Yes|Yes|M1, JobBOSS², Macola
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2_view_sales-order-jobs
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
orderLineDelivery[eq]: abc123
jobID[eq]: abc123
orderJobSeq[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/sales-order-lines:
get:
tags:
- View
summary: Gets a list of SalesOrderLine
description: 'Gets a list of SalesOrderLine.
## Supported ERPs
- M1
- Macola
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, Macola, JobBOSS², Deacom
orderLine|Yes|Yes|M1, Macola, JobBOSS², Deacom
totalSalePrice|Yes|Yes|M1, Macola, JobBOSS², Deacom
uniqueID|Yes|Yes|M1, Macola, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, Macola, JobBOSS², Deacom
partID|No|Yes|M1, Macola, JobBOSS², Deacom
partRevisionID|No|Yes|M1, Macola, JobBOSS², Deacom
partGroupID|No|Yes|M1, Macola, JobBOSS², Deacom
shortDescription|No|Yes|M1, Macola, JobBOSS², Deacom
saleUom|No|Yes|M1, Macola, JobBOSS², Deacom
baseUnitPrice|No|Yes|M1, Macola, JobBOSS², Deacom
foreignUnitPrice|No|Yes|M1, Macola, JobBOSS², Deacom
baseExtendedPrice|No|Yes|M1, Macola, JobBOSS², Deacom
foreignExtendedPrice|No|Yes|M1, Macola, JobBOSS², Deacom
quantityOrdered|No|Yes|M1, Macola, JobBOSS², Deacom
quantityShipped|No|Yes|M1, Macola, JobBOSS², Deacom
purchaseOrderCost|No|Yes|M1, Macola, JobBOSS², Deacom
purchaseOrderCostForeign|No|Yes|M1, Macola, JobBOSS², Deacom
salesOrderType|No|Yes|Macola
locationID|No|Yes|Macola
shippedDate|No|Yes|Macola
isPosted|No|Yes|Macola
dueDate|No|Yes|JobBOSS²'
operationId: GET__api_v2_view_sales-order-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
orderLine[gte]: 123
totalSalePrice[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrderDeliveries|SalesOrderDeliveries[]|
salesOrderJobs|SalesOrderJobs|
salesOrder|SalesOrders|
partRevision|PartRevisions|
partGroup|PartGroups|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderLine_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderLine_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/sales-orders:
get:
tags:
- View
summary: Gets a list of SalesOrder
description: 'Gets a list of SalesOrder.
## Supported ERPs
- M1
- Macola
- JobBOSS²
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1, Macola, JobBOSS², Deacom
rowVersion|Yes|Yes|M1, Macola, JobBOSS², Deacom
salesOrderID|Yes|Yes|M1, Macola, JobBOSS², Deacom
customerID|Yes|Yes|M1, Macola, JobBOSS², Deacom
orderDate|Yes|Yes|M1, Macola, JobBOSS², Deacom
plantID|No|Yes|M1, Macola, JobBOSS², Deacom
projectID|No|Yes|M1, Macola, JobBOSS², Deacom
salesOrderType|No|Yes|Macola
totalSalesAmount|No|Yes|Macola
status|No|Yes|Macola
originalOrderType|No|Yes|Macola
quoteID|No|Yes|Macola
closedDate|Yes|Yes|Macola'
operationId: GET__api_v2_view_sales-orders
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
salesOrderID[eq]: abc123
customerID[eq]: abc123
orderDate[gte]: '2020-09-25T00:00:00.0000000'
closedDate[gte]: '2020-09-25T00:00:00.0000000'
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
customer|Organizations|The Customer Organization record.
plant|Plants|The Plant record.
project|Projects|The Project record for this Sales Order.
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrder'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrder'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/sales-order-sales-people:
get:
tags:
- View
summary: Gets a list of SalesOrderSalesPerson
description: 'Gets a list of SalesOrderSalesPerson.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
salesOrderID|Yes|Yes|M1, Macola
salesEmployeeID|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
isActive|Yes|Yes|M1, Macola
sequenceNo|No|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola
salesOrderType|No|Yes|Macola
percentage|No|Yes|Macola'
operationId: GET__api_v2_view_sales-order-sales-people
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
salesOrderID[eq]: abc123
salesEmployeeID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
isActive[eq]: true
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
salesOrder|SalesOrders|
salesEmployee|Employees|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderSalesPerson_2'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SalesOrderSalesPerson_2'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/shift-days:
get:
tags:
- View
summary: Gets a list of ShiftDay
description: 'Gets a list of ShiftDay.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
shiftID|Yes|Yes|M1, Macola
shiftDay|Yes|Yes|M1, Macola
startTime|Yes|Yes|M1, Macola
endTime|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_shift-days
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
shiftID[eq]: abc123
shiftDay[eq]: abc123
startTime[eq]: abc123
endTime[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/shifts:
get:
tags:
- View
summary: Gets a list of Shift
description: 'Gets a list of Shift.
## Supported ERPs
- M1
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
shiftID|Yes|Yes|M1, Macola
shortDesc|Yes|Yes|M1, Macola
inactiveDate|Yes|Yes|M1, Macola
uniqueID|Yes|Yes|M1, Macola
rowVersion|Yes|Yes|M1, Macola'
operationId: GET__api_v2_view_shifts
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
shiftID[eq]: abc123
shortDesc[eq]: abc123
inactiveDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
shiftDays|ShiftDays[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shift'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shift'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/shipment-lines:
get:
tags:
- View
summary: Gets a list of ShipmentLine
description: 'Gets a list of ShipmentLine.
## Supported ERPs
- M1
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
uniqueID|Yes|Yes|M1
rowVersion|Yes|Yes|M1
shipmentID|Yes|Yes|M1
shipmentLineID|Yes|Yes|M1
partID|Yes|Yes|M1
partRevisionID|Yes|Yes|M1
description|No|Yes|M1
partWarehouseID|Yes|Yes|M1
partBinID|Yes|Yes|M1
invQtyShipped|No|Yes|M1
jobQtyShipped|No|Yes|M1
unitPriceForeign|No|Yes|M1
extendedPriceForeign|No|Yes|M1
isShippedComplete|Yes|Yes|M1
unitOfMeasure|No|Yes|M1
salesOrderID|Yes|Yes|M1
salesOrderLineID|Yes|Yes|M1
salesOrderDeliveryID|Yes|Yes|M1
jobID|Yes|Yes|M1
partGroupID|Yes|Yes|M1
projectID|Yes|Yes|M1'
operationId: GET__api_v2_view_shipment-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
shipmentID[eq]: abc123
shipmentLineID[eq]: abc123
partID[eq]: abc123
partRevisionID[eq]: abc123
partWarehouseID[eq]: abc123
partBinID[eq]: abc123
isShippedComplete[eq]: true
salesOrderID[eq]: abc123
salesOrderLineID[eq]: abc123
salesOrderDeliveryID[eq]: abc123
jobID[eq]: abc123
partGroupID[eq]: abc123
projectID[eq]: abc123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShipmentLine'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShipmentLine'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/tax-codes:
get:
tags:
- View
summary: Gets a list of TaxCode
description: 'Gets a list of TaxCode.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
description|No|Yes|JobBOSS²
taxCodeID|No|Yes|JobBOSS²
isActive|No|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_tax-codes
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
rowVersion[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaxCode'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaxCode'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/timecard-lines:
get:
tags:
- View
summary: Gets a list of TimecardLine
description: 'Gets a list of TimecardLine.
## Supported ERPs
- M1
- JobBOSS²
- Macola
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timecardID|Yes|Yes|M1, JobBOSS², Macola
timecardLine|Yes|Yes|M1, JobBOSS², Macola
jobID|Yes|Yes|M1, JobBOSS², Macola
jobAssembly|Yes|Yes|M1, JobBOSS², Macola
jobOperation|Yes|Yes|M1, JobBOSS², Macola
workCenterID|Yes|Yes|M1, JobBOSS², Macola
processID|Yes|Yes|M1, JobBOSS², Macola
status|Yes|Yes|M1, JobBOSS², Macola
timecardType|Yes|Yes|M1, JobBOSS², Macola
goodQty|Yes|Yes|M1, JobBOSS², Macola
scrapQty|Yes|Yes|M1, JobBOSS², Macola
reworkQty|Yes|Yes|M1, JobBOSS², Macola
rejectQty|Yes|Yes|M1, JobBOSS², Macola
startTime|Yes|Yes|M1, JobBOSS², Macola
endTime|Yes|Yes|M1, JobBOSS², Macola
machineHours|Yes|Yes|M1, JobBOSS², Macola
laborHours|Yes|Yes|M1, JobBOSS², Macola
employeeID|Yes|Yes|JobBOSS²
timecardDate|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS², Macola
rowVersion|Yes|Yes|M1, JobBOSS², Macola'
operationId: GET__api_v2_view_timecard-lines
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timecardID[eq]: abc123
timecardLine[eq]: abc123
jobID[eq]: abc123
jobAssembly[eq]: abc123
jobOperation[gte]: 123
workCenterID[eq]: abc123
processID[eq]: abc123
status[eq]: abc123
timecardType[eq]: abc123
goodQty[gte]: 123
scrapQty[gte]: 123
reworkQty[gte]: 123
rejectQty[gte]: 123
startTime[gte]: '2020-09-25T04:03:00.0000000'
endTime[gte]: '2020-09-25T04:03:00.0000000'
machineHours[gte]: 123
laborHours[gte]: 123
employeeID[gte]: 123
timecardDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
workCenters|WorkCenters[]|This relationship is obsolete and will be removed in a future release. Use ''workCenter'' instead
workCenter|WorkCenters|The workcenter associated with this line.
timecards|Timecards[]|This relationship is obsolete and will be removed in a future release. Use ''timecard'' instead
timecard|Timecards|The timecard record associated with this line.
jobs|Jobs|This relationship is obsolete and will be removed in a future release. Use ''job'' instead
job|Jobs|The Job associated with this line.
processes|Processes|This relationship is obsolete and will be removed in a future release. Use ''process'' instead
process|Processes|The Process associated with this line.
jobOperations|JobOperations|This relationship is obsolete and will be removed in a future release. Use ''jobOperation'' instead
jobOperationx|JobOperations|The Job Operation associated with this line.
salesOrderDeliveries|SalesOrderDeliveries[]|
salesOrderJobs|SalesOrderJobs|This relationship is obsolete and will be removed in a future release. Use ''salesOrderJob'' instead
salesOrderJob|SalesOrderJobs|The Sales Order Job associated with this line.
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimecardLine_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimecardLine_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/timecards:
get:
tags:
- View
summary: Gets a list of Timecard
description: 'Gets a list of Timecard.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timecardID|Yes|Yes|M1, JobBOSS², Macola, Deacom
employeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom
timecardDate|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom'
operationId: GET__api_v2_view_timecards
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timecardID[eq]: abc123
employeeID[eq]: abc123
shiftID[eq]: abc123
timecardDate[gte]: '2020-09-25T04:03:00.0000000'
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
timecardlines|Timecardlines[]|
employees|Employees[]|
'
schema:
type: string
- name: convertToUTC
in: query
description: Convert suppported date/time values to UTC before returning the data.
schema:
type: boolean
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Timecard'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Timecard'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/timezones:
get:
tags:
- View
summary: Gets a list of TimeZone
description: 'Gets a list of TimeZone.
## Supported ERPs
- M1
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
timeZoneName|Yes|Yes|M1, JobBOSS²
uniqueID|Yes|Yes|M1, JobBOSS²
rowVersion|Yes|Yes|M1, JobBOSS²'
operationId: GET__api_v2_view_timezones
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
timeZoneName[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeZone'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TimeZone'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/work-center-rate-breaks:
get:
tags:
- View
summary: Gets a list of WorkCenterRateBreak
description: 'Gets a list of WorkCenterRateBreak.
## Supported ERPs
- JobBOSS²
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
workCenterID|Yes|Yes|JobBOSS²
shortDesc|Yes|Yes|JobBOSS²
ordinal|Yes|Yes|JobBOSS²
setupRate|Yes|Yes|JobBOSS²
prodRate|Yes|Yes|JobBOSS²
uniqueID|Yes|Yes|JobBOSS²
rowVersion|Yes|Yes|JobBOSS²
laborRate|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_work-center-rate-breaks
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
workCenterID[eq]: abc123
shortDesc[eq]: abc123
ordinal[gte]: 123
setupRate[gte]: 123
prodRate[gte]: 123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
laborRate[eq]: abc123
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenterRateBreak'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenterRateBreak'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
/api/v2/view/work-centers:
get:
tags:
- View
summary: Gets a list of WorkCenter
description: 'Gets a list of WorkCenter.
## Supported ERPs
- M1
- JobBOSS²
- Macola
- Deacom
## Resource Features
Feature |Supported |Notes
------------|------------|------------
Filter Expressions|**Yes**|
Sort Expressions|**Yes**
Field Selection|**Yes**
Pagination|**Yes**
UniqueID|uniqueID|
## Features by Field
Field |Filterable |Sortable |Supported ERPs
------------|------------|------------|------------
workCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom
deptID|Yes|Yes|M1, JobBOSS², Macola, Deacom
overHeadRate|Yes|Yes|M1, JobBOSS², Macola, Deacom
quoteRate|Yes|Yes|M1, JobBOSS², Macola, Deacom
processID|Yes|Yes|M1, JobBOSS², Macola, Deacom
parentWorkCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom
shiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom
uniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom
rowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom
laborRate|Yes|Yes|JobBOSS²'
operationId: GET__api_v2_view_work-centers
parameters:
- name: fields
in: query
description: A comma-separated list of fields to include in the result.
schema:
type: string
- name: sort
in: query
description: A comma-separated list of sort expressions.
schema:
type: string
- name: take
in: query
description: Limit the number of results being returned
schema:
minimum: 0
type: integer
- name: skip
in: query
description: The number of results to skip. Combine with 'take' to fetch records in pages
schema:
minimum: 0
type: integer
- name: count
in: query
description: 'Data and count response behavior '
schema:
maximum: 2
minimum: 0
type: integer
- name: filters
in: query
description: See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.
style: form
schema:
type: object
additionalProperties:
type: string
examples:
Empty:
description: No filters applied
'Example #1':
description: A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```
value:
workCenterID[eq]: abc123
shortDesc[eq]: abc123
deptID[eq]: abc123
overHeadRate[eq]: abc123
quoteRate[eq]: abc123
processID[eq]: abc123
parentWorkCenterID[eq]: abc123
shiftID[eq]: abc123
uniqueID[eq]: cc90686b-399e-4094-b431-fa462f84b0a8
rowVersion[gte]: 123
laborRate[eq]: abc123
- name: expand
in: query
description: '### Supported Expansions
An expansion expression containing a comma separater list of relationships to expand.
Name |Value |Description
------------|------------|-----------
departments|Departments[]|
shifts|Shifts[]|
'
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenter_3'
resultCount:
type:
- integer
- 'null'
text/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkCenter_3'
resultCount:
type:
- integer
- 'null'
servers:
- url: https://api-erp.integrations.ecimanufacturing.com:443
description: Production
components:
schemas:
Job:
title: Job
type: object
properties:
jobID:
type: string
customerID:
type: string
partID:
type: string
partRevisionID:
type: string
orderQty:
type: number
format: double
prodQty:
type: number
format: double
schedStartDate:
type: string
format: date-time
schedEndDate:
type: string
format: date-time
estLeadTime:
type: number
format: double
actStartDate:
type: string
format: date-time
actEndDate:
type: string
format: date-time
dueDate:
type: string
format: date-time
status:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
parentJobID:
type: string
jobOperations:
type: array
items:
$ref: '#/components/schemas/JobOperation'
JobOperation:
title: JobOperation
type: object
properties:
jobID:
type: string
jobAssembly:
type: string
jobOperationSeq:
type: integer
format: int32
status:
type: string
workCenterID:
type: string
processID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
outsideOperation:
type: string
partID:
type: string
partRevisionID:
type: string
schedStartDate:
type: string
format: date-time
schedEndDate:
type: string
format: date-time
actStartDate:
type: string
format: date-time
actEndDate:
type: string
format: date-time
estSetupHours:
type: number
format: double
estProdHours:
type: number
format: double
estQueueHours:
type: number
format: double
estMoveHours:
type: number
format: double
estQAHours:
type: number
format: double
actSetupHours:
type: number
format: double
actualProdHours:
type: number
format: double
actQAHours:
type: number
format: double
vendorID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
WorkCenter:
title: WorkCenter
type: object
properties:
workCenterID:
type: string
shortDesc:
type: string
deptID:
type: string
overHeadRate:
type: string
quoteRate:
type: string
processID:
type: string
parentWorkCenterID:
type: string
shiftID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
departments:
type: array
items:
$ref: '#/components/schemas/Department'
shifts:
type: array
items:
$ref: '#/components/schemas/Shift'
Employee:
title: Employee
type: object
properties:
employeeID:
type: string
firstName:
type: string
lastName:
type: string
title:
type: string
supervisorEmployeeID:
type: integer
format: int32
payRate:
type: number
format: double
deptID:
type: string
shiftID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
Department:
title: Department
type: object
properties:
deptID:
type: string
shortDesc:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
Shift:
title: Shift
type: object
properties:
shiftID:
type: number
format: float
shortDesc:
type: string
inactiveDate:
type: string
format: date-time
uniqueID:
type: string
rowVersion:
type: integer
format: int64
shiftDays:
type: array
items:
$ref: '#/components/schemas/ShiftDay'
SalesOrderDelivery:
title: SalesOrderDelivery
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
orderLineDelivery:
type: string
promisedDate:
type: string
format: date-time
promisedQty:
type: number
format: double
shippedDate:
type: string
format: date-time
shippedQty:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
salesOrderJobs:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob'
TimecardLine:
title: TimecardLine
type: object
properties:
timecardID:
type: string
timecardLine:
type: string
jobID:
type: string
jobAssembly:
type: string
jobOperation:
type: integer
format: int32
workCenterID:
type: string
processID:
type: string
status:
type: string
timecardType:
type: string
goodQty:
type: number
format: double
scrapQty:
type: number
format: double
reworkQty:
type: number
format: double
rejectQty:
type: number
format: double
startTime:
type: string
format: date-time
endTime:
type: string
format: date-time
machineHours:
type: number
format: double
laborHours:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
workCenters:
type: array
items:
$ref: '#/components/schemas/WorkCenter'
timecards:
type: array
items:
$ref: '#/components/schemas/Timecard'
jobs:
$ref: '#/components/schemas/Job'
processes:
$ref: '#/components/schemas/Process'
jobOperations:
$ref: '#/components/schemas/JobOperation'
salesOrderDeliveries:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery'
salesOrderJobs:
$ref: '#/components/schemas/SalesOrderJob'
TimeZone:
title: TimeZone
type: object
properties:
timeZoneName:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
SalesOrderJob:
title: SalesOrderJob
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
orderLineDelivery:
type: string
jobID:
type: string
orderJobSeq:
type: integer
uniqueID:
type: string
rowVersion:
type: integer
format: int64
ShiftDay:
title: ShiftDay
type: object
properties:
shiftID:
type: number
format: float
shiftDay:
type: number
format: float
startTime:
type: string
endTime:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
ProductionCalendar:
title: ProductionCalendar
type: object
properties:
productionDate:
type: string
format: date-time
productionHours:
type: number
format: double
productionStartTime:
type: string
workCenterID:
type: string
plantID:
type: string
department:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartRevision:
title: PartRevision
type: object
properties:
partID:
type: string
partRevisionID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartOperation:
title: PartOperation
type: object
properties:
partID:
type: string
partRevisionID:
type: string
partOperationSeq:
type: integer
format: int32
workCenterID:
type: string
processID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
outsideOperation:
type: string
estSetupHours:
type: number
format: double
estProdHours:
type: number
format: double
estQueueHours:
type: number
format: double
estMoveHours:
type: number
format: double
estQAHours:
type: number
format: double
vendorID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
Timecard:
title: Timecard
type: object
properties:
timecardID:
type: string
employeeID:
type: string
shiftID:
type: number
format: float
timecardDate:
type: string
format: date-time
uniqueID:
type: string
rowVersion:
type: integer
format: int64
timecardlines:
type: array
items:
$ref: '#/components/schemas/TimecardLine'
employees:
type: array
items:
$ref: '#/components/schemas/Employee'
Process:
title: Process
type: object
properties:
processID:
type: string
shortDesc:
type: string
setupRate:
type: string
productionRate:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
SalesOrderLine:
title: SalesOrderLine
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
totalSalePrice:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
salesOrderDeliveries:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery'
salesOrderJobs:
$ref: '#/components/schemas/SalesOrderJob'
RmaClaimLine:
title: RmaClaimLine
type: object
properties:
unitPrice:
type: number
format: double
foreignUnitPrice:
type: number
format: double
extendedPrice:
type: number
format: double
foreignExtendedPrice:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
claimID:
type: string
claimLineID:
type: string
quantity:
type: integer
format: int64
partID:
type: string
partRevisionID:
type: string
claim:
$ref: '#/components/schemas/RmaClaim'
JobOperation_2:
title: JobOperation
type: object
properties:
jobID:
type: string
jobAssembly:
type: string
jobOperationSeq:
type: integer
format: int32
status:
type: string
workCenterID:
type: string
processID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
outsideOperation:
type: string
partID:
type: string
partRevisionID:
type: string
schedStartDate:
type: string
format: date-time
schedEndDate:
type: string
format: date-time
actStartDate:
type: string
format: date-time
actEndDate:
type: string
format: date-time
estSetupHours:
type: number
format: double
estProdHours:
type: number
format: double
estQueueHours:
type: number
format: double
estMoveHours:
type: number
format: double
estQAHours:
type: number
format: double
actSetupHours:
type: number
format: double
actualProdHours:
type: number
format: double
actQAHours:
type: number
format: double
vendorID:
type: string
estSetupTimeValue:
type: number
format: double
estSetupTimeUnit:
type: string
estProdTimeValue:
type: number
format: double
estProdTimeUnit:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
operationQty:
type: number
format: double
quantityComplete:
type: number
format: double
isSetupComplete:
type: boolean
plantID:
type: string
purchaseOrderID:
type: string
supplierOrganizationID:
type: string
purchaseLocationID:
type: string
RFQID:
type: string
defaultEmployeeID:
type: string
defaultEmployeeID2:
type: string
defaultEmployeeID3:
type: string
isUnattended:
type: boolean
jobType:
type: string
supplierLeadTime:
type: integer
format: int32
jobIsClosed:
type: boolean
jobClosedDate:
type: string
format: date-time
ARInvoiceSalesPerson:
title: ARInvoiceSalesPerson
type: object
properties:
invoiceID:
type: string
employeeID:
type: string
sequenceID:
type: integer
format: int32
uniqueID:
type: string
rowVersion:
type: integer
format: int64
SalesOrderSalesPerson:
title: SalesOrderSalesPerson
type: object
properties:
salesOrderID:
type: string
salesEmployeeID:
type: string
uniqueID:
type: string
isActive:
type: boolean
sequenceNo:
type: integer
format: int32
rowVersion:
type: integer
format: int64
salesOrderType:
type: string
percentage:
type: number
format: double
salesOrder:
$ref: '#/components/schemas/SalesOrder'
salesEmployee:
$ref: '#/components/schemas/Employee_2'
OrganizationPart:
title: OrganizationPart
type: object
properties:
partID:
type: string
partRevisionID:
type: string
organizationID:
type: string
organizationTypes:
type: array
items:
type: integer
format: int32
organizationPartID:
type: string
organizationShortDesc:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
SalesOrderDelivery_2:
title: SalesOrderDelivery
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
orderLineDelivery:
type: string
promisedDate:
type: string
format: date-time
promisedQty:
type: number
format: double
shippedDate:
type: string
format: date-time
shippedQty:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
deliveryTypeCode:
type: string
salesOrderType:
type: string
salesOrderJobs:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob_2'
TimecardLine_2:
title: TimecardLine
type: object
properties:
timecardID:
type: string
timecardLine:
type: string
jobID:
type: string
jobAssembly:
type: string
jobOperation:
type: integer
format: int32
workCenterID:
type: string
processID:
type: string
status:
type: string
timecardType:
type: string
goodQty:
type: number
format: double
scrapQty:
type: number
format: double
reworkQty:
type: number
format: double
rejectQty:
type: number
format: double
startTime:
type: string
format: date-time
endTime:
type: string
format: date-time
machineHours:
type: number
format: double
laborHours:
type: number
format: double
employeeID:
type: integer
format: int32
timecardDate:
type: string
format: date-time
uniqueID:
type: string
rowVersion:
type: integer
format: int64
workCenters:
type: array
items:
$ref: '#/components/schemas/WorkCenter_2'
workCenter:
$ref: '#/components/schemas/WorkCenter_2'
timecards:
type: array
items:
$ref: '#/components/schemas/Timecard'
timecard:
$ref: '#/components/schemas/Timecard'
jobs:
$ref: '#/components/schemas/Job_2'
job:
$ref: '#/components/schemas/Job_2'
processes:
$ref: '#/components/schemas/Process'
process:
$ref: '#/components/schemas/Process'
jobOperations:
$ref: '#/components/schemas/JobOperation_2'
jobOperationx:
$ref: '#/components/schemas/JobOperation_2'
salesOrderDeliveries:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_2'
salesOrderJobs:
$ref: '#/components/schemas/SalesOrderJob_2'
salesOrderJob:
$ref: '#/components/schemas/SalesOrderJob_2'
Contact:
title: Contact
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
contactID:
type: string
name:
type: string
organizationID:
type: string
organizationTypes:
type: array
items:
type: integer
format: int32
phoneNumber:
type: string
emailAddress:
type: string
isActive:
type: boolean
comments:
type: string
organization:
$ref: '#/components/schemas/Organization'
Organization:
title: Organization
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
name:
type: string
organizationID:
type: string
country:
type: string
isActive:
type: boolean
organizationTypes:
type: array
items:
type: integer
format: int32
phoneNumber:
type: string
customerPaymentTermID:
type: string
customerTaxCodeID:
type: string
supplierPaymentTermID:
type: string
supplierTaxCodeID:
type: string
currencyCode:
type: string
websiteUrl:
type: string
comments:
type: string
salesAccountID:
type: string
leadTimeDays:
type: integer
format: int32
minimumOrderAmount:
type: number
format: double
customerStatus:
type: integer
supplierStatus:
type: integer
Quote:
title: Quote
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
quoteID:
type: string
employeeID:
type: string
organizationID:
type: string
locationID:
type: string
contactID:
type: string
invoiceLocationID:
type: string
quoteDate:
type: string
format: date
dueDate:
type: string
format: date
isClosed:
type: boolean
closedDate:
type: string
format: date
currencyRateID:
type: string
customerID:
type: string
expirationDate:
type: string
format: date
plantID:
type: string
projectID:
type: string
shipToOrganizationID:
type: string
shipToContactID:
type: string
shipToLocationID:
type: string
statusCode:
type: string
totalSalesAmount:
type: number
format: double
awardProbability:
type: number
format: double
lostSaleCode:
type: string
customer:
$ref: '#/components/schemas/Organization'
contact:
$ref: '#/components/schemas/Contact'
shipTo:
$ref: '#/components/schemas/Organization'
shipToContact:
$ref: '#/components/schemas/Contact'
project:
$ref: '#/components/schemas/Project'
PartRevision_2:
title: PartRevision
type: object
properties:
partID:
type: string
partRevisionID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partCost:
type: number
format: double
effectiveStartDate:
type: string
format: date
expirationEndDate:
type: string
format: date
supplierOrganizationID:
type: string
leadTime:
type: integer
format: int32
quantityOnHand:
type: number
format: double
pricingUnitOfMeasure:
type: string
JobAssembly:
title: JobAssembly
type: object
properties:
jobID:
type: string
jobAssemblyID:
type: string
level:
type: integer
parentAssemblyID:
type: string
sourceMethodID:
type: string
sourceRevisionID:
type: string
partID:
type: string
partRevisionID:
type: string
partShortDesc:
type: string
quantityPerParent:
type: number
format: double
orderQty:
type: number
format: double
inventoryQty:
type: number
format: double
scrapQty:
type: number
format: double
quantityToInspect:
type: number
format: double
quantityRcvdToInv:
type: number
format: double
productionQty:
type: number
format: double
quantityToMake:
type: number
format: double
quantityToPull:
type: number
format: double
quantityIssued:
type: number
format: double
quantityCompleted:
type: number
format: double
isProductionComplete:
type: boolean
completedDate:
type: string
format: date-time
uniqueID:
type: string
rowVersion:
type: integer
format: int64
jobIsClosed:
type: boolean
jobClosedDate:
type: string
format: date-time
PaymentTerm:
title: PaymentTerm
type: object
properties:
description:
type: string
paymentTermID:
type: string
rowVersion:
type: integer
format: int64
uniqueID:
type: string
PartCostBreak:
title: PartCostBreak
type: object
properties:
partCostID:
type: string
quantity:
type: number
format: double
unitCost:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
DmrClaimLine:
title: DmrClaimLine
type: object
properties:
claimLineID:
type: string
partID:
type: string
partRevisionID:
type: string
partShortDescription:
type: string
partLongDescription:
type: string
partWarehouseID:
type: string
quantity:
type: number
format: double
quantityShipped:
type: number
format: double
unitOfMeasure:
type: string
unitCost:
type: number
format: double
foreignUnitCost:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
claimID:
type: string
claim:
$ref: '#/components/schemas/DmrClaim'
part:
$ref: '#/components/schemas/Part'
partRevision:
$ref: '#/components/schemas/PartRevision_2'
InspectionLine:
title: InspectionLine
type: object
properties:
notes:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
inspectionID:
type: string
inspectionLineID:
type: string
partID:
type: string
partRevisionID:
type: string
partWarehouseID:
type: string
partBinID:
type: string
quantityToInspect:
type: number
format: double
supplierOrganizationID:
type: string
isInspectionComplete:
type: boolean
unitCost:
type: number
format: double
projectID:
type: string
projectAreaID:
type: string
inspectionDate:
type: string
format: date-time
sourceType:
type: integer
format: int32
inspectorEmployeeID:
type: string
JobMaterial:
title: JobMaterial
type: object
properties:
jobID:
type: string
jobAssemblyID:
type: string
jobAssemblySeq:
type: integer
format: int32
materialPartID:
type: string
materialPartRevisionID:
type: string
estQuantity:
type: number
format: double
estUnitCost:
type: number
format: double
unitOfMeasure:
type: string
leadTime:
type: number
format: double
vendorID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
jobIsClosed:
type: boolean
jobClosedDate:
type: string
format: date-time
jobType:
type: string
ARInvoice:
title: ARInvoice
type: object
properties:
invoiceID:
type: string
invoiceDate:
type: string
format: date
dueDate:
type: string
format: date
invoiceType:
type: integer
format: int32
isPostedToGL:
type: boolean
postedDate:
type: string
format: date
isOnHold:
type: boolean
isOverpayment:
type: boolean
paymentTermID:
type: string
invoiceTotalBase:
type: number
format: double
invoiceTotalForeign:
type: number
format: double
invoiceBalanceBase:
type: number
format: double
invoiceBalanceForeign:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
customerID:
type: string
paidDate:
type: string
format: date
plantID:
type: string
Employee_2:
title: Employee
type: object
properties:
employeeID:
type: string
firstName:
type: string
lastName:
type: string
title:
type: string
supervisorEmployeeID:
type: string
payRate:
type: number
format: double
deptID:
type: string
shiftID:
type: string
isActive:
type: boolean
uniqueID:
type: string
rowVersion:
type: integer
format: int64
SalesOrder:
title: SalesOrder
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
salesOrderID:
type: string
customerID:
type: string
orderDate:
type: string
format: date
plantID:
type: string
projectID:
type: string
salesOrderType:
type: string
totalSalesAmount:
type: number
format: double
status:
type: string
originalOrderType:
type: string
quoteID:
type: string
closedDate:
type: string
format: date
customer:
$ref: '#/components/schemas/Organization'
plant:
$ref: '#/components/schemas/Plant'
project:
$ref: '#/components/schemas/Project'
Reason:
title: Reason
type: object
properties:
reasonID:
type: string
description:
type: string
name:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
Location:
title: Location
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
locationID:
type: string
name:
type: string
organizationID:
type: string
organizationTypes:
type: array
items:
type: integer
format: int32
addressLine1:
type: string
addressLine2:
type: string
addressLine3:
type: string
city:
type: string
county:
type: string
country:
type: string
postalCode:
type: string
state:
type: string
isActive:
type: boolean
locationTypes:
type: array
items:
type: integer
format: int32
organization:
$ref: '#/components/schemas/Organization'
SalesOrderJob_2:
title: SalesOrderJob
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
orderLineDelivery:
type: string
jobID:
type: string
orderJobSeq:
type: integer
format: int32
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartGroup:
title: PartGroup
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partGroupID:
type: string
parentPartGroupID:
type: string
description:
type: string
isActive:
type: boolean
inactiveDate:
type: string
format: date
QuoteQuantity:
title: QuoteQuantity
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
quoteQuantityID:
type: string
quoteID:
type: string
quoteLineID:
type: string
quantity:
type: number
format: double
baseUnitPrice:
type: number
description: The price expressed in the currency of the seller.
format: double
foreignUnitPrice:
type: number
description: The price expressed in the currency of the buyer, if different from that of the seller.
format: double
quote:
$ref: '#/components/schemas/Quote'
quoteLine:
$ref: '#/components/schemas/QuoteLine'
Project:
title: Project
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
projectID:
type: string
customerID:
type: string
locationID:
type: string
contactID:
type: string
dueDate:
type: string
format: date
projectDate:
type: string
format: date
closedDate:
type: string
format: date
shortDescription:
type: string
longDescription:
type: string
statusCode:
type: string
isClosed:
type: boolean
customer:
$ref: '#/components/schemas/Organization'
TaxCode:
title: TaxCode
type: object
properties:
description:
type: string
taxCodeID:
type: string
isActive:
type: boolean
rowVersion:
type: integer
format: int64
uniqueID:
type: string
WorkCenterRateBreak:
title: WorkCenterRateBreak
type: object
properties:
workCenterID:
type: string
shortDesc:
type: string
ordinal:
type: integer
setupRate:
type: number
format: double
prodRate:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
laborRate:
type: string
PartOperation_2:
title: PartOperation
type: object
properties:
partID:
type: string
partRevisionID:
type: string
partOperationSeq:
type: integer
format: int32
workCenterID:
type: string
processID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
outsideOperation:
type: string
estSetupHours:
type: number
format: double
estProdHours:
type: number
format: double
estQueueHours:
type: number
format: double
estMoveHours:
type: number
format: double
estQAHours:
type: number
format: double
vendorID:
type: string
estSetupTimeValue:
type: number
format: double
estSetupTimeUnit:
type: string
estProdTimeValue:
type: number
format: double
estProdTimeUnit:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
APInvoiceLine:
title: APInvoiceLine
type: object
properties:
invoiceID:
type: string
lineID:
type: string
itemType:
type: string
partID:
type: string
partRevisionID:
type: string
partDescription:
type: string
purchaseQuantity:
type: number
format: double
baseUnitCost:
type: number
format: double
foreignUnitCost:
type: number
format: double
baseExtendedCost:
type: number
format: double
foreignExtendedCost:
type: number
format: double
baseSetupCharge:
type: number
format: double
foreignSetupCharge:
type: number
format: double
unitOfMeasure:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
ShipmentLine:
title: ShipmentLine
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
shipmentID:
type: string
shipmentLineID:
type: string
partID:
type: string
partRevisionID:
type: string
description:
type: string
partWarehouseID:
type: string
partBinID:
type: string
invQtyShipped:
type: number
format: double
jobQtyShipped:
type: number
format: double
unitPriceForeign:
type: number
format: double
extendedPriceForeign:
type: number
format: double
isShippedComplete:
type: boolean
unitOfMeasure:
type: string
salesOrderID:
type: string
salesOrderLineID:
type: string
salesOrderDeliveryID:
type: string
jobID:
type: string
partGroupID:
type: string
projectID:
type: string
QuoteLine:
title: QuoteLine
type: object
properties:
uniqueID:
type: string
rowVersion:
type: integer
format: int64
quoteID:
type: string
partID:
type: string
partRevisionID:
type: string
partGroupID:
type: string
shortDescription:
type: string
quoteQuantityID:
type: string
description: The QuoteQuantity record identifier to be used when calculating a Quote Total.
quoteLineID:
type: string
resolutionReasonID:
type: string
locationID:
type: string
quote:
$ref: '#/components/schemas/Quote'
resolutionReason:
$ref: '#/components/schemas/Reason'
partGroup:
$ref: '#/components/schemas/PartGroup'
Part:
title: Part
type: object
properties:
partClassID:
type: string
partGroupID:
type: string
cycleCodeID:
type: string
partType:
type: integer
format: int32
partID:
type: string
alternatePartID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
isActive:
type: boolean
partClass:
$ref: '#/components/schemas/PartClass'
partGroup:
$ref: '#/components/schemas/PartGroup'
RmaReceiptLine:
title: RmaReceiptLine
type: object
properties:
description:
type: string
isInspected:
type: boolean
partID:
type: string
partLongDescription:
type: string
partRevisionID:
type: string
partWarehouseID:
type: string
projectID:
type: string
isReceived:
type: boolean
inspectionRequired:
type: boolean
claimLineID:
type: string
claimQuantity:
type: number
format: double
receiptID:
type: string
receiptLineID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
isClosed:
type: boolean
isReversed:
type: boolean
claimID:
type: string
claim:
$ref: '#/components/schemas/RmaClaim'
claimLine:
$ref: '#/components/schemas/RmaClaimLine'
WorkCenter_2:
title: WorkCenter
type: object
properties:
workCenterID:
type: string
shortDesc:
type: string
deptID:
type: string
overHeadRate:
type: string
quoteRate:
type: string
processID:
type: string
parentWorkCenterID:
type: string
shiftID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
laborRate:
type: string
departments:
type: array
items:
$ref: '#/components/schemas/Department'
shifts:
type: array
items:
$ref: '#/components/schemas/Shift'
APInvoice:
title: APInvoice
type: object
properties:
invoiceID:
type: string
invoiceDate:
type: string
format: date
dueDate:
type: string
format: date
invoiceType:
type: integer
format: int32
isPostedToGL:
type: boolean
postedDate:
type: string
format: date
isOnHold:
type: boolean
isOverpayment:
type: boolean
paymentTermID:
type: string
baseTotal:
type: number
format: double
foreignTotal:
type: number
format: double
baseBalance:
type: number
format: double
foreignBalance:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
currency:
type: string
supplierID:
type: string
paidDate:
type: string
format: date
plantID:
type: string
PartClass:
title: PartClass
type: object
properties:
description:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partClassID:
type: string
isActive:
type: boolean
PartTransaction:
title: PartTransaction
type: object
properties:
partTransactionID:
type: string
partID:
type: string
partRevisionID:
type: string
transactionType:
type: integer
source:
type: integer
receiptType:
type: integer
isNonInventoryTransaction:
type: boolean
purchaseOrderID:
type: string
jobID:
type: string
partWarehouseID:
type: string
partBinID:
type: string
supplierOrganizationID:
type: string
inventoryQtyRcvd:
type: number
format: double
scrapQty:
type: number
format: double
quantityToInspect:
type: number
format: double
quantityToReturn:
type: number
format: double
purchaseQtyRcvd:
type: number
format: double
purchaseUnitCost:
type: number
format: double
transactionDate:
type: string
format: date-time
reference:
type: string
shipmentID:
type: string
shipmentLineID:
type: string
receiptID:
type: string
DMRShipmentID:
type: string
RMAReceiptID:
type: string
inspectionID:
type: string
inventoryCountID:
type: string
warehouseTransferID:
type: string
warehouseReceiptID:
type: string
projectID:
type: string
projectAreaID:
type: string
plantID:
type: string
costType:
type: integer
quantity:
type: number
format: double
unitLaborCost:
type: number
format: double
unitOverheadCost:
type: number
format: double
unitMaterialCost:
type: number
format: double
unitSubcontractCost:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartMaterial:
title: PartMaterial
type: object
properties:
partID:
type: string
partRevisionID:
type: string
partOperationSeq:
type: integer
format: int32
materialPartID:
type: string
materialPartRevisionID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
quantity:
type: number
format: double
unitOfMeasure:
type: string
partAssemblyID:
type: string
partAssemblySeq:
type: integer
format: int32
Plant:
title: Plant
type: object
properties:
plantID:
type: string
name:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
QuoteSalesPerson:
title: QuoteSalesPerson
type: object
properties:
quoteID:
type: string
employeeID:
type: string
percentage:
type: number
format: double
isClosed:
type: boolean
uniqueID:
type: string
rowVersion:
type: integer
format: int64
sequenceNo:
type: integer
format: int32
quote:
$ref: '#/components/schemas/Quote'
SalesOrderLine_2:
title: SalesOrderLine
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
totalSalePrice:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partID:
type: string
partRevisionID:
type: string
partGroupID:
type: string
shortDescription:
type: string
saleUom:
type: string
baseUnitPrice:
type: number
description: The price expressed in the currency of the seller.
format: double
foreignUnitPrice:
type: number
description: The price expressed in the currency of the buyer, if different from that of the seller.
format: double
baseExtendedPrice:
type: number
description: The extended (qty x price) total expressed in the currency of the seller.
format: double
foreignExtendedPrice:
type: number
description: The extended (qty x price) total expressed in the currency of the buyer, if different from that of the seller.
format: double
quantityOrdered:
type: number
format: double
quantityShipped:
type: number
format: double
purchaseOrderCost:
type: number
format: double
purchaseOrderCostForeign:
type: number
format: double
salesOrderType:
type: string
locationID:
type: string
shippedDate:
type: string
format: date-time
isPosted:
type: boolean
dueDate:
type: string
format: date-time
salesOrderDeliveries:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_2'
salesOrderJobs:
$ref: '#/components/schemas/SalesOrderJob_2'
salesOrder:
$ref: '#/components/schemas/SalesOrder'
partRevision:
$ref: '#/components/schemas/PartRevision_2'
partGroup:
$ref: '#/components/schemas/PartGroup'
GLCode:
title: GLCode
type: object
properties:
description:
type: string
glCodeID:
type: string
rowVersion:
type: integer
format: int64
uniqueID:
type: string
isActive:
type: boolean
DmrClaim:
title: DmrClaim
type: object
properties:
claimID:
type: string
supplierOrganizationID:
type: string
claimDate:
type: string
format: date
claimTotal:
type: number
format: double
foreignTotal:
type: number
format: double
currency:
type: string
plantID:
type: string
projectID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
status:
type: string
supplier:
$ref: '#/components/schemas/Organization'
plant:
$ref: '#/components/schemas/Plant'
project:
$ref: '#/components/schemas/Project'
Job_2:
title: Job
type: object
properties:
jobID:
type: string
customerID:
type: string
partID:
type: string
partRevisionID:
type: string
orderQty:
type: number
format: double
prodQty:
type: number
format: double
schedStartDate:
type: string
format: date-time
schedEndDate:
type: string
format: date-time
estLeadTime:
type: number
format: double
actStartDate:
type: string
format: date-time
actEndDate:
type: string
format: date-time
dueDate:
type: string
format: date-time
status:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
jobCost:
type: number
format: double
jobCostForeign:
type: number
format: double
plantID:
type: string
jobDate:
type: string
format: date-time
partWarehouseID:
type: string
partBinID:
type: string
partShortDesc:
type: string
inventoryQty:
type: number
format: double
isPlanningComplete:
type: boolean
isScheduleComplete:
type: boolean
isReleasedToFloor:
type: boolean
isOnHold:
type: boolean
completedDate:
type: string
format: date-time
quantityCompleted:
type: number
format: double
quantityShipped:
type: number
format: double
quantityRcvdToInventory:
type: number
format: double
projectID:
type: string
projectAreaID:
type: string
isClosed:
type: boolean
closedDate:
type: string
format: date-time
jobPriorityID:
type: string
unitOfMeasure:
type: string
plannerEmployeeID:
type: string
parentJobID:
type: string
shortDesc:
type: string
childJobID:
type: string
jobType:
type: string
jobOperations:
type: array
items:
$ref: '#/components/schemas/JobOperation_2'
CycleCode:
title: CycleCode
type: object
properties:
description:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
cycleCodeID:
type: string
PurchaseOrderLine:
title: PurchaseOrderLine
type: object
properties:
dueDate:
type: string
format: date
extendedCost:
type: number
format: double
foreignExtendedCost:
type: number
format: double
partID:
type: string
partRevisionID:
type: string
partDescription:
type: string
partWarehouse:
type: string
purchaseOrderLineID:
type: string
quantity:
type: number
format: double
quantityReceived:
type: number
format: double
unitCost:
type: number
format: double
foreignUnitCost:
type: number
format: double
isReceived:
type: boolean
inspectionRequired:
type: boolean
uniqueID:
type: string
rowVersion:
type: integer
format: int64
isClosed:
type: boolean
purchaseOrderID:
type: string
unitOfMeasure:
type: string
jobID:
type: string
purchaseOrder:
$ref: '#/components/schemas/PurchaseOrder'
PartPriceBreak:
title: PartPriceBreak
type: object
properties:
partPriceID:
type: string
quantity:
type: number
format: double
unitPrice:
type: number
format: double
markup:
type: number
format: double
discount:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartBin:
title: PartBin
type: object
properties:
partRevisionID:
type: string
warehouseID:
type: string
partBinID:
type: string
quantityOnHand:
type: number
format: double
quantityAllocated:
type: number
format: double
quantityOnOrderSales:
type: number
format: double
quantityOnOrderPurchases:
type: number
format: double
quantityToInspect:
type: number
format: double
quantityToReturn:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partID:
type: string
lotNumber:
type: string
purchaseOrderLineID:
type: string
partRevision:
$ref: '#/components/schemas/PartRevision_2'
SalesAccount:
title: SalesAccount
type: object
properties:
salesAccountID:
type: string
name:
type: string
isActive:
type: boolean
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartPrice:
title: PartPrice
type: object
properties:
partPriceID:
type: string
partID:
type: string
partRevisionID:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
isCustomerSpecific:
type: boolean
uniqueID:
type: string
rowVersion:
type: integer
format: int64
RmaClaim:
title: RmaClaim
type: object
properties:
claimDate:
type: string
format: date
claimTotal:
type: number
format: double
foreignTotal:
type: number
format: double
currency:
type: string
customerOrganizationID:
type: string
plantID:
type: string
claimID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
status:
type: string
customer:
$ref: '#/components/schemas/Organization'
PurchaseOrder:
title: PurchaseOrder
type: object
properties:
apInvoiceLocationID:
type: string
buyerEmployeeID:
type: string
currency:
type: string
orderDate:
type: string
format: date
plantID:
type: string
projectID:
type: string
purchaseOrderID:
type: string
supplierOrganizationID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
isClosed:
type: boolean
JobOperation_3:
title: JobOperation
type: object
properties:
jobID:
type: string
jobAssembly:
type: string
jobOperationSeq:
type: integer
format: int32
status:
type: string
workCenterID:
type: string
processID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
outsideOperation:
type: string
partID:
type: string
partRevisionID:
type: string
schedStartDate:
type: string
format: date-time
schedEndDate:
type: string
format: date-time
actStartDate:
type: string
format: date-time
actEndDate:
type: string
format: date-time
estSetupHours:
type: number
format: double
estProdHours:
type: number
format: double
estQueueHours:
type: number
format: double
estMoveHours:
type: number
format: double
estQAHours:
type: number
format: double
actSetupHours:
type: number
format: double
actualProdHours:
type: number
format: double
actQAHours:
type: number
format: double
vendorID:
type: string
estSetupTimeValue:
type: number
format: double
estSetupTimeUnit:
type: string
estProdTimeValue:
type: number
format: double
estProdTimeUnit:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
operationQty:
type: number
format: double
quantityComplete:
type: number
format: double
isSetupComplete:
type: boolean
plantID:
type: string
purchaseOrderID:
type: string
supplierOrganizationID:
type: string
purchaseLocationID:
type: string
RFQID:
type: string
defaultEmployeeID:
type: string
defaultEmployeeID2:
type: string
defaultEmployeeID3:
type: string
isUnattended:
type: boolean
jobType:
type: string
supplierLeadTime:
type: integer
format: int32
jobIsClosed:
type: boolean
jobClosedDate:
type: string
format: date-time
SalesOrderSalesPerson_2:
title: SalesOrderSalesPerson
type: object
properties:
salesOrderID:
type: string
salesEmployeeID:
type: string
uniqueID:
type: string
isActive:
type: boolean
sequenceNo:
type: integer
format: int32
rowVersion:
type: integer
format: int64
salesOrderType:
type: string
percentage:
type: number
format: double
salesOrder:
$ref: '#/components/schemas/SalesOrder'
salesEmployee:
$ref: '#/components/schemas/Employee_3'
SalesOrderDelivery_3:
title: SalesOrderDelivery
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
orderLineDelivery:
type: string
promisedDate:
type: string
format: date-time
promisedQty:
type: number
format: double
shippedDate:
type: string
format: date-time
shippedQty:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
deliveryTypeCode:
type: string
salesOrderType:
type: string
salesOrderJobs:
type: array
items:
$ref: '#/components/schemas/SalesOrderJob_3'
TimecardLine_3:
title: TimecardLine
type: object
properties:
timecardID:
type: string
timecardLine:
type: string
jobID:
type: string
jobAssembly:
type: string
jobOperation:
type: integer
format: int32
workCenterID:
type: string
processID:
type: string
status:
type: string
timecardType:
type: string
goodQty:
type: number
format: double
scrapQty:
type: number
format: double
reworkQty:
type: number
format: double
rejectQty:
type: number
format: double
startTime:
type: string
format: date-time
endTime:
type: string
format: date-time
machineHours:
type: number
format: double
laborHours:
type: number
format: double
employeeID:
type: integer
format: int32
timecardDate:
type: string
format: date-time
uniqueID:
type: string
rowVersion:
type: integer
format: int64
workCenters:
type: array
items:
$ref: '#/components/schemas/WorkCenter_3'
workCenter:
$ref: '#/components/schemas/WorkCenter_3'
timecards:
type: array
items:
$ref: '#/components/schemas/Timecard'
timecard:
$ref: '#/components/schemas/Timecard'
jobs:
$ref: '#/components/schemas/Job_3'
job:
$ref: '#/components/schemas/Job_3'
processes:
$ref: '#/components/schemas/Process'
process:
$ref: '#/components/schemas/Process'
jobOperations:
$ref: '#/components/schemas/JobOperation_3'
jobOperationx:
$ref: '#/components/schemas/JobOperation_3'
salesOrderDeliveries:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_3'
salesOrderJobs:
$ref: '#/components/schemas/SalesOrderJob_3'
salesOrderJob:
$ref: '#/components/schemas/SalesOrderJob_3'
PartRevision_3:
title: PartRevision
type: object
properties:
partID:
type: string
partRevisionID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partCost:
type: number
format: double
effectiveStartDate:
type: string
format: date
expirationEndDate:
type: string
format: date
supplierOrganizationID:
type: string
leadTime:
type: integer
format: int32
quantityOnHand:
type: number
format: double
pricingUnitOfMeasure:
type: string
DmrClaimLine_2:
title: DmrClaimLine
type: object
properties:
claimLineID:
type: string
partID:
type: string
partRevisionID:
type: string
partShortDescription:
type: string
partLongDescription:
type: string
partWarehouseID:
type: string
quantity:
type: number
format: double
quantityShipped:
type: number
format: double
unitOfMeasure:
type: string
unitCost:
type: number
format: double
foreignUnitCost:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
claimID:
type: string
claim:
$ref: '#/components/schemas/DmrClaim'
part:
$ref: '#/components/schemas/Part'
partRevision:
$ref: '#/components/schemas/PartRevision_3'
Employee_3:
title: Employee
type: object
properties:
employeeID:
type: string
firstName:
type: string
lastName:
type: string
title:
type: string
supervisorEmployeeID:
type: string
payRate:
type: number
format: double
deptID:
type: string
shiftID:
type: string
isActive:
type: boolean
uniqueID:
type: string
rowVersion:
type: integer
format: int64
SalesOrderJob_3:
title: SalesOrderJob
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
orderLineDelivery:
type: string
jobID:
type: string
orderJobSeq:
type: integer
format: int32
uniqueID:
type: string
rowVersion:
type: integer
format: int64
PartOperation_3:
title: PartOperation
type: object
properties:
partID:
type: string
partRevisionID:
type: string
partOperationSeq:
type: integer
format: int32
workCenterID:
type: string
processID:
type: string
shortDesc:
type: string
longDescText:
type: string
longDescFormatted:
type: string
outsideOperation:
type: string
estSetupHours:
type: number
format: double
estProdHours:
type: number
format: double
estQueueHours:
type: number
format: double
estMoveHours:
type: number
format: double
estQAHours:
type: number
format: double
vendorID:
type: string
estSetupTimeValue:
type: number
format: double
estSetupTimeUnit:
type: string
estProdTimeValue:
type: number
format: double
estProdTimeUnit:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
WorkCenter_3:
title: WorkCenter
type: object
properties:
workCenterID:
type: string
shortDesc:
type: string
deptID:
type: string
overHeadRate:
type: string
quoteRate:
type: string
processID:
type: string
parentWorkCenterID:
type: string
shiftID:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
laborRate:
type: string
departments:
type: array
items:
$ref: '#/components/schemas/Department'
shifts:
type: array
items:
$ref: '#/components/schemas/Shift'
SalesOrderLine_3:
title: SalesOrderLine
type: object
properties:
salesOrderID:
type: string
orderLine:
type: integer
totalSalePrice:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partID:
type: string
partRevisionID:
type: string
partGroupID:
type: string
shortDescription:
type: string
saleUom:
type: string
baseUnitPrice:
type: number
description: The price expressed in the currency of the seller.
format: double
foreignUnitPrice:
type: number
description: The price expressed in the currency of the buyer, if different from that of the seller.
format: double
baseExtendedPrice:
type: number
description: The extended (qty x price) total expressed in the currency of the seller.
format: double
foreignExtendedPrice:
type: number
description: The extended (qty x price) total expressed in the currency of the buyer, if different from that of the seller.
format: double
quantityOrdered:
type: number
format: double
quantityShipped:
type: number
format: double
purchaseOrderCost:
type: number
format: double
purchaseOrderCostForeign:
type: number
format: double
salesOrderType:
type: string
locationID:
type: string
shippedDate:
type: string
format: date-time
isPosted:
type: boolean
dueDate:
type: string
format: date-time
salesOrderDeliveries:
type: array
items:
$ref: '#/components/schemas/SalesOrderDelivery_3'
salesOrderJobs:
$ref: '#/components/schemas/SalesOrderJob_3'
salesOrder:
$ref: '#/components/schemas/SalesOrder'
partRevision:
$ref: '#/components/schemas/PartRevision_3'
partGroup:
$ref: '#/components/schemas/PartGroup'
Job_3:
title: Job
type: object
properties:
jobID:
type: string
customerID:
type: string
partID:
type: string
partRevisionID:
type: string
orderQty:
type: number
format: double
prodQty:
type: number
format: double
schedStartDate:
type: string
format: date-time
schedEndDate:
type: string
format: date-time
estLeadTime:
type: number
format: double
actStartDate:
type: string
format: date-time
actEndDate:
type: string
format: date-time
dueDate:
type: string
format: date-time
status:
type: string
uniqueID:
type: string
rowVersion:
type: integer
format: int64
jobCost:
type: number
format: double
jobCostForeign:
type: number
format: double
plantID:
type: string
jobDate:
type: string
format: date-time
partWarehouseID:
type: string
partBinID:
type: string
partShortDesc:
type: string
inventoryQty:
type: number
format: double
isPlanningComplete:
type: boolean
isScheduleComplete:
type: boolean
isReleasedToFloor:
type: boolean
isOnHold:
type: boolean
completedDate:
type: string
format: date-time
quantityCompleted:
type: number
format: double
quantityShipped:
type: number
format: double
quantityRcvdToInventory:
type: number
format: double
projectID:
type: string
projectAreaID:
type: string
isClosed:
type: boolean
closedDate:
type: string
format: date-time
jobPriorityID:
type: string
unitOfMeasure:
type: string
plannerEmployeeID:
type: string
parentJobID:
type: string
shortDesc:
type: string
childJobID:
type: string
jobType:
type: string
jobOperations:
type: array
items:
$ref: '#/components/schemas/JobOperation_3'
PartBin_2:
title: PartBin
type: object
properties:
partRevisionID:
type: string
warehouseID:
type: string
partBinID:
type: string
quantityOnHand:
type: number
format: double
quantityAllocated:
type: number
format: double
quantityOnOrderSales:
type: number
format: double
quantityOnOrderPurchases:
type: number
format: double
quantityToInspect:
type: number
format: double
quantityToReturn:
type: number
format: double
uniqueID:
type: string
rowVersion:
type: integer
format: int64
partID:
type: string
lotNumber:
type: string
purchaseOrderLineID:
type: string
partRevision:
$ref: '#/components/schemas/PartRevision_3'
securitySchemes:
Bearer:
type: oauth2
description: OAuth 2.0 Client Credentials Flow with API Users issued from Integration Engine Management Console
flows:
clientCredentials:
tokenUrl: https://api-user.integrations.ecimanufacturing.com/oauth2/api-user/token
scopes:
openid: openid
x-refined-from:
- eci-solutions-erp-v1-openapi.json
- eci-solutions-erp-v2-1-openapi.json
- eci-solutions-erp-v2-openapi.json