{
"openapi": "3.0.1",
"info": {
"title": "JobBOSS² Public API",
"description": "\nProvides a common API surface for accessing ECI ERP JobBOSS².\n\n## Authentication\n\nPass an access token in the HTTP Authorization header of each request. For example:\n\n```Authorization: Bearer [token]```\n\nAccess tokens are obtained from the Management API. See the Management API OAuth 2.0 Token endpoint documentation for more information.\n\n## Date and Time Fields\n\nAll dates submitted to the API are assumed to be in UTC. Likewise, all dates returned from the API are in UTC.\n\n### Format of Date/Time Fields\nWhen submitting date and datetime fields through the Web API, values should match the following formats `yyyy-MM-ddTHH:mm:ssZ or yyyy-MM-dd`\n\n\n## Currency Fields\n\nThe `Quote` and `QuoteLineItem` endpoints contain fields like `price1` and `price1Foreign` or `miscCharge` and `miscChargeForeign`.\nFor a list of the relevant fields for each endpoint, look at the documentation about that endpoint.\n\nIn these cases the value in `price1` and `miscCharge` represents the currency used by the company (as configured in company settings)\nand the value in the `price1Foreign` and `miscChargeForeign` represents the currency used by the customer that is set on that Quote.\n\nIf the customer uses the same currency as the company, then only the non-`foreign` fields should be used. \n\nWhen using a POST or PATCH request to set currency values, only one of the fields may be used in the request. The\nother field will be calculated using the relevant exchange rate. To submit the request with a value using the company's currency, use\nthe `price1` or `miscCharge` field. To submit the request with a value using the customer's currency, use the `price1Foreign` or\n`miscChargeForeign` field.\n\n\n## Fields Expressions\n\nBy default, most GET requests will not return all of the available fields for a given resource.\nRefer to the individual GET request documentation for a list of the default fields that will be included.\nIf you do not want the default fields, you can apply a fields expression to the query string parameters\nin the format `fields=fieldOne,fieldTwo,fieldThree`.\n\n\n## Filter Expressions\n\nFor resources that support filtering, filter expressions can be applied as query string parameters in\nthe format ```fieldName[operator]=value```\n\nNote, for simple equality, you can omit the operator, e.g. `?firstName=Jane`\n\n### Operators\n\n- `[eq]` Equal to the given value.\n\n- `[ne]` Not Equal to the given value.\n\n- `[gte]` Greater than or equal to the given value.\n\n- `[lte]` Less than or equal to the given value.\n\n- `[gt]` Greater than the given value.\n\n- `[lt]` Less than the given value.\n\n- `[in]` Is in a list of pipe separated values.\n\n- `[notin]` Is not in a list of pipe separated values.\n\n- `[null]` Is null. To test if a field is null use `fieldName[NULL]=true`. Please note that the `revisedDate` field cannot be tested for null (it can never be null). Using `[NULL]` with `revisedDate` will result in a 500 server error.\n\nIf you have multiple filters to apply, concatenate them in the query string using `&` just for joining other parameters.\n\nExamples:\n```\n?customerCode=ACME\n?customerCode[eq]=ACME&orderTotal[gte]=3700\n```\n\n\n## Paging Parameters\nThe parameters ```take``` and ```skip``` can be provided separately but can be combined to implement\nserver-side paging of results.\n\nFor example:\n```\n?take=100\n?take=100&skip=200\n```\nBy default `take` is set to 200.\n\n\n\n## Sort Expressions\nFor resources that support sorting, the sort expression is specified by adding the ```sort```\nquery string parameter, with a comma separated list of expressions as its value,\neach expression having an optional prefix of ```+``` or ```-``` to indicate ascending or descending order.\n\nFor example:\n```\n?sort=firstName\n?sort=+lastName,+firstName\n?sort=-createDate\n```\n\n## Error Responses\n\nError responses are return in the JSON format shown below:\n\n### A sample 404 Not Found\n```json\n{\n \"Title\": \"Not Found\",\n \"Status\": 404,\n \"Detail\": \"\",\n \"TraceId\": \"\"\n}\n```\n### A sample 500 Internal Server Error\n\n```json\n{\n \"Title\": \"An error occured while processing your request.\",\n \"Status\": 500,\n \"Detail\": \"\",\n \"TraceId\": \"\"\n}\n```\n",
"version": "v1"
},
"servers": [
{
"url": "https://api-jb2.integrations.ecimanufacturing.com:443",
"description": "API Host"
}
],
"paths": {
"/api/v1/eci-aps/authenticate-user": {
"post": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/eci-aps/get-schedule": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/authenticate-user": {
"post": {
"tags": [
"null"
],
"parameters": [
{
"name": "userID",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/filters": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/get-jobs": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/grid-option": {
"post": {
"tags": [
"null"
],
"parameters": [
{
"name": "option",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "columnID",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/grid-options": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/kpi-definitions": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/kpi/jobs-closed": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/kpi/jobs-in-progress": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/kpi/jobs-on-hold": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/kpi/jobs-past-due": {
"get": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/shopview/reset-grid-options": {
"post": {
"tags": [
"null"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/ap-checks": {
"get": {
"tags": [
"AP Checks"
],
"summary": "Gets a list of AP Checks",
"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 field to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters as query string parameters",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records to skip.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"post": {
"tags": [
"AP Checks"
],
"summary": "Creates a new AP Check",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": { }
},
"application/json": {
"schema": { }
},
"text/json": {
"schema": { }
},
"application/*+json": {
"schema": { }
}
}
},
"responses": {
"200": {
"description": "Check created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectSuccessResponse"
}
}
}
},
"400": {
"description": "Invalid request data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"Error": {
"Title": "Internal Server Error",
"Status": 500,
"Detail": "Internal Server Error",
"TraceId": "21b68bf3-57a4-4012-9562-58c154c63908"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"Error": {
"Title": "Internal Server Error",
"Status": 500,
"Detail": "Internal Server Error",
"TraceId": "6ccd7c18-189a-48d2-ab44-888d0488261b"
}
}
}
}
}
}
}
},
"/api/v1/ap-checks/{checkNumber}": {
"get": {
"tags": [
"AP Checks"
],
"summary": "Gets a single AP Check by check number",
"parameters": [
{
"name": "checkNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Check not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"Error": {
"Title": "Internal Server Error",
"Status": 500,
"Detail": "Internal Server Error",
"TraceId": "45de8eec-9710-44af-b8b9-8e6d5abb002a"
}
}
}
}
}
}
}
},
"/api/v1/ar-invoice-details": {
"get": {
"tags": [
"AR Invoice Details"
],
"summary": "Gets a list of AR Invoice Details",
"description": "By default an AR invoice details response will include only the fields: commissionPercent, contactName, deliveryTicketDate, deliveryTicketNumber, discountPercent, GLAccount1, inventoryItemNumber, invoiceNumber, isTaxable, jobNumber, lastModDate, lineTotal, lineTotalForeign, partDescription, partNumber, PONumber, productCode, quantityCancelled, quantityOrdered, quantityShipped, revision, salesAccount, salesAmount1, salesAmountForeign1, taxStatus, uniqueID, unit, unitPrice, unitPriceForeign, workCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Invoice Number": {
"value": {
"invoiceNumber": "4691"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ARInvoiceDetailListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"commissionPercent": 0,
"contactName": "string",
"deliveryTicketDate": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketNumber": "string",
"discountPercent": 0,
"FOB": "string",
"GLAccount1": "string",
"GLAccount2": "string",
"GLAccount3": "string",
"GLAccount4": "string",
"GLAccount5": "string",
"inventoryItemNumber": 0,
"invoiceNumber": "string",
"isTaxable": false,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lineTotal": 0,
"lineTotalForeign": 0,
"partDescription": "string",
"partNumber": "string",
"PONumber": "string",
"productCode": "string",
"quantityCancelled": 0,
"quantityOrdered": 0,
"quantityShipped": 0,
"revision": "string",
"salesAccount": "string",
"salesAmount1": 0,
"salesAmount2": 0,
"salesAmount3": 0,
"salesAmount4": 0,
"salesAmount5": 0,
"salesAmountForeign1": 0,
"salesAmountForeign2": 0,
"salesAmountForeign3": 0,
"salesAmountForeign4": 0,
"salesAmountForeign5": 0,
"taxStatus": false,
"uniqueID": 0,
"unit": "string",
"unitPrice": 0,
"unitPriceForeign": 0,
"workCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/ar-invoices": {
"get": {
"tags": [
"AR Invoices"
],
"summary": "Gets a list of AR Invoices",
"description": "By default an AR invoice response will include only the fields: amountPaidSoFar, amountPaidSoFarForeign, ARAccount, currencyCode, customerCode, customerDescription, daysOverdue, deliverTicketNumber, discountDate, enteredBy, exchangeRate, invoiceDate, invoiceNumber, invoiceTotal, invoiceTotalForeign, lastModDate, location, netDueDate, notes, openInvoiceAmount, paymentDate, paymentStatus, periodNumber, projectedPayDate, salesID, taxAccount, taxCode, termsCode, territory, uniqueID, workCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Status (Unpaid)": {
"value": {
"paymentStatus": "UNPAID"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ARInvoiceListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"amountPaidSoFar": 0,
"amountPaidSoFarForeign": 0,
"ARAccount": "string",
"cashDiscountAmount": 0,
"cashDiscountAmountForeign": 0,
"country": "string",
"currencyCode": "string",
"customerCheckNumber": "string",
"customerCode": "string",
"customerDescription": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"daysOverdue": 0,
"deliverTicketNumber": "string",
"discountAccount": "string",
"discountDate": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"exportedToEDI": false,
"exportedToQB": false,
"freightAccount": "string",
"GSTAccount": "string",
"GSTCharges": 0,
"GSTChargesForeign": 0,
"GSTCode": "string",
"ignoreMinimumOrder": false,
"invoiceDate": "2026-09-06T17:13:12.0000000+00:00",
"invoiceNumber": "string",
"invoicePosted": false,
"invoicePrinted": false,
"invoiceTotal": 0,
"invoiceTotalForeign": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"netDueDate": "2026-09-06T17:13:12.0000000+00:00",
"notes": "string",
"openInvoiceAmount": 0,
"paymentDate": "2026-09-06T17:13:12.0000000+00:00",
"paymentStatus": "string",
"periodNumber": "string",
"projectedPayDate": "2026-09-06T17:13:12.0000000+00:00",
"salesID": "string",
"salesTaxCharges": 0,
"salesTaxChargesForeign": 0,
"shippingAddress1": "string",
"shippingCharges": 0,
"shippingChargesForeign": 0,
"shippingCity": "string",
"shippingCode": "string",
"shippingStreet": "string",
"shippingZip": "string",
"shipToName": "string",
"shipVia": "string",
"taxAccount": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"workCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/attendance-ticket-details": {
"get": {
"tags": [
"Attendance Ticket Details"
],
"summary": "Gets a list of Attendance Ticket Details",
"description": "By default an Attendance Ticket Detail item response will include only the fields: accountingID, actualClockInDate, actualClockInTime, actualClockOutDate, actualClockOutTime, adjustedClockInDate, adjustedClockInTime, adjustedClockOutDate, adjustedClockOutTime, attendanceCode, clockOutDate, comments, createdBy, deviceNumber, employeeCode, employeeName, GLCode, isHoliday, isOvertime, lastModDate, lastModUser, OTCalcFlag, payRateCode, payRollRate, searchDate, shift, ticketDate, totalActualTime, totalAdjustedTime, uniqueID",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Employee": {
"value": {
"employeeCode": "101"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendanceDetailListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"actualClockInDate": "string",
"actualClockInTime": "string",
"actualClockOutDate": "string",
"actualClockOutTime": "string",
"adjustedClockInDate": "string",
"adjustedClockInTime": "string",
"adjustedClockOutDate": "string",
"adjustedClockOutTime": "string",
"attendanceCode": 0,
"clockOutDate": "2026-09-06T17:13:13.0000000+00:00",
"comments": "string",
"createdBy": "string",
"deviceNumber": 0,
"employeeCode": 0,
"employeeName": "string",
"GLCode": "string",
"isHoliday": false,
"isOvertime": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"OTCalcFlag": "string",
"payRateCode": 0,
"payRollRate": 0,
"searchDate": 0,
"shift": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"totalActualTime": 0,
"totalAdjustedTime": 0,
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/attendance-ticket-details/{id}": {
"patch": {
"tags": [
"Attendance Ticket Details"
],
"summary": "Updates an Attendance Ticket Detail",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendanceDetailUpdate"
},
"example": {
"actualClockInTime": "string",
"actualClockOutTime": "string",
"adjustedClockInTime": "string",
"adjustedClockOutTime": "string",
"attendanceCode": 0,
"clockOutDate": "2026-09-06T17:13:13.0000000+00:00",
"comments": "string",
"GLCode": "string",
"isHoliday": false,
"isOvertime": false,
"payRateCode": 0,
"shift": 0
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/attendance-tickets/{ticketDate}/employees/{employeeCode}/attendance-ticket-details": {
"post": {
"tags": [
"Attendance Ticket Details"
],
"summary": "Creates an Attendance Ticket Detail",
"parameters": [
{
"name": "ticketDate",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employeeCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendanceDetailCreate"
},
"example": {
"actualClockInTime": "string",
"actualClockOutTime": "string",
"adjustedClockInTime": "string",
"adjustedClockOutTime": "string",
"attendanceCode": 0,
"clockOutDate": "2026-09-06T17:13:13.0000000+00:00",
"comments": "string",
"GLCode": "string",
"isHoliday": false,
"isOvertime": false,
"payRateCode": 0,
"shift": 0
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendanceDetail"
},
"example": {
"accountingID": "string",
"actualClockInDate": "string",
"actualClockInTime": "string",
"actualClockOutDate": "string",
"actualClockOutTime": "string",
"adjustedClockInDate": "string",
"adjustedClockInTime": "string",
"adjustedClockOutDate": "string",
"adjustedClockOutTime": "string",
"attendanceCode": 0,
"clockOutDate": "2026-09-06T17:13:13.0000000+00:00",
"comments": "string",
"createdBy": "string",
"deviceNumber": 0,
"employeeCode": 0,
"employeeName": "string",
"GLCode": "string",
"isHoliday": false,
"isOvertime": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"OTCalcFlag": "string",
"payRateCode": 0,
"payRollRate": 0,
"searchDate": 0,
"shift": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"totalActualTime": 0,
"totalAdjustedTime": 0,
"uniqueID": 0
}
}
}
}
}
}
},
"/api/v1/attendance-tickets": {
"get": {
"tags": [
"Attendance Tickets"
],
"summary": "Gets a list of Attendance Tickets",
"description": "By default an attendance ticket response will include only the fields: employeeCode, employeeName, enteredBy, enteredDate, isExported, lastModDate, lastModUser, searchDate, ticketDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Employee": {
"value": {
"employeeCode": "101"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendanceListSuccessResponse"
},
"example": {
"Data": [
{
"employeeCode": 0,
"employeeName": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"isExported": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"searchDate": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Attendance Tickets"
],
"summary": "Creates an Attendance Ticket",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttendanceTicketCreate"
},
"example": {
"employeeCode": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendance"
},
"example": {
"employeeCode": 0,
"employeeName": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"isExported": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"searchDate": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0
}
}
}
}
}
}
},
"/api/v1/attendance-tickets/{ticketDate}/employees/{employeeCode}": {
"get": {
"tags": [
"Attendance Tickets"
],
"summary": "Gets an Attendance Ticket by its unique ID",
"description": "By default an attendance ticket response will include only the fields: employeeCode, employeeName, enteredBy, enteredDate, isExported, lastModDate, lastModUser, searchDate, ticketDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "ticketDate",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employeeCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeAndAttendanceSuccessResponse"
},
"example": {
"Data": {
"employeeCode": 0,
"employeeName": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"isExported": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"searchDate": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/oauth2Exchange": {
"post": {
"tags": [
"Authentication"
],
"parameters": [
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "signalToken",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/bin-locations": {
"get": {
"tags": [
"Bin Locations"
],
"summary": "Gets a list of Bin Locations",
"description": "By default a bin location response will include only the fields: binLocation, cost, datePosted, deliveryTicketNumber, lastModDate, lastModUser, lotNumber, partNumber, POItemNumber, quantityOnHand, receiverNumber, uniqueID, vendorCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Part Number": {
"value": {
"partNumber": "415-P-26A"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BinLocationListSuccessResponse"
},
"example": {
"Data": [
{
"binLocation": "string",
"cost": 0,
"datePosted": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"partNumber": "string",
"POItemNumber": 0,
"quantityOnHand": 0,
"receiverNumber": "string",
"uniqueID": 0,
"vendorCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/company": {
"get": {
"tags": [
"Company"
],
"summary": "Gets a company",
"description": "By default a company response will include all fields. You may specify the exact fields to return using the fields parameter.",
"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 fields to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expression section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Company Code": {
"value": {
"companyCode": "ABC"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyListSuccessResponse"
},
"example": {
"Data": [
{
"accountsPayableAccount": "string",
"accountsReceivableAccount": "string",
"billingDrivenBy": "string",
"billingRateDescription1": "string",
"billingRateDescription10": "string",
"billingRateDescription2": "string",
"billingRateDescription3": "string",
"billingRateDescription4": "string",
"billingRateDescription5": "string",
"billingRateDescription6": "string",
"billingRateDescription7": "string",
"billingRateDescription8": "string",
"billingRateDescription9": "string",
"cashDiscountAccount": "string",
"companyCode": "string",
"companyCountry": "string",
"companyDescription": "string",
"companyTimeZone": "string",
"currencyCode": "string",
"currentEarningsAccount": "string",
"freightAccount": "string",
"payrollRateDescription1": "string",
"payrollRateDescription10": "string",
"payrollRateDescription2": "string",
"payrollRateDescription3": "string",
"payrollRateDescription4": "string",
"payrollRateDescription5": "string",
"payrollRateDescription6": "string",
"payrollRateDescription7": "string",
"payrollRateDescription8": "string",
"payrollRateDescription9": "string",
"productCode": "string",
"purchaseDiscountAccount": "string",
"reportDateFormat": "string",
"retainedEarningsAccount": "string",
"useA4PaperSize": false,
"workCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/company-calendars": {
"get": {
"tags": [
"Company Calendar"
],
"summary": "Gets a list of Company Calendars",
"description": "By default a company calendar response will include only the fields: calendarType, capacityFactor, code, date, hoursAvailable, hoursAvailableShift1, hoursAvailableShift2, hoursAvailableShift3, lastModDate, lastModUser, scheduleBegin, scheduleEnd, searchDate, shift1Begin, shift1DefaultEmployeeCode, shift1End, shift2Begin, shift2CapacityFactor, shift2DefaultEmployeeCode, shift2End, shift3Begin, shift3CapacityFactor, shift3DefaultEmployeeCode, shift3End, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by SearchDate": {
"value": {
"searchDate": "3"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyCalendarListSuccessResponse"
},
"example": {
"Data": [
{
"calendarType": "string",
"capacityFactor": 0,
"code": "string",
"date": "2026-09-06T17:13:12.0000000+00:00",
"hoursAvailable": 0,
"hoursAvailableShift1": 0,
"hoursAvailableShift2": 0,
"hoursAvailableShift3": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"scheduleBegin": "string",
"scheduleEnd": "string",
"searchDate": 0,
"shift1Begin": "string",
"shift1DefaultEmployeeCode": "string",
"shift1End": "string",
"shift2Begin": "string",
"shift2CapacityFactor": 0,
"shift2DefaultEmployeeCode": "string",
"shift2End": "string",
"shift3Begin": "string",
"shift3CapacityFactor": 0,
"shift3DefaultEmployeeCode": "string",
"shift3End": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/contacts": {
"get": {
"tags": [
"Contacts"
],
"summary": "Gets a list of Contacts",
"description": "By default a contact response will include only the fields: active, cellPhone, comments, contact, contactCode, email, extension, lastModDate, mobileEmail, object, phone, title, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Customer Code": {
"value": {
"object": "CUST",
"contactCode": "BASS"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"cellPhone": "string",
"comments": "string",
"contact": "string",
"contactCode": "string",
"email": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"extension": "string",
"fax": "string",
"isOptedOut": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"mobileEmail": "string",
"object": "string",
"phone": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"title": "string",
"uniqueID": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Contacts"
],
"summary": "Creates a Contact",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactCreate"
},
"example": {
"active": false,
"cellPhone": "string",
"comments": "string",
"contact": "string",
"contactCode": "string",
"email": "string",
"extension": "string",
"fax": "string",
"isOptedOut": false,
"mobileEmail": "string",
"object": "string",
"phone": "string",
"title": "string"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
},
"example": {
"active": false,
"cellPhone": "string",
"comments": "string",
"contact": "string",
"contactCode": "string",
"email": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"extension": "string",
"fax": "string",
"isOptedOut": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"mobileEmail": "string",
"object": "string",
"phone": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"title": "string",
"uniqueID": 0
}
}
}
}
}
}
},
"/api/v1/contacts/{object}/{contactCode}/{contact}": {
"get": {
"tags": [
"Contacts"
],
"summary": "Gets a Contact by specifying the object, the contact code and the contact ",
"description": "By default a contact response will include only the fields: active, cellPhone, code, comments, contact, uniqueID, email, extension, lastModDate, mobile, object, phone, title. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "object",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contactCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contact",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactSuccessResponse"
},
"example": {
"Data": {
"active": false,
"cellPhone": "string",
"comments": "string",
"contact": "string",
"contactCode": "string",
"email": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"extension": "string",
"fax": "string",
"isOptedOut": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"mobileEmail": "string",
"object": "string",
"phone": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"title": "string",
"uniqueID": 0
}
}
}
}
}
}
},
"patch": {
"tags": [
"Contacts"
],
"summary": "Updates a Contact",
"parameters": [
{
"name": "object",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contactCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contact",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactUpdate"
},
"example": {
"active": false,
"cellPhone": "string",
"comments": "string",
"email": "string",
"extension": "string",
"fax": "string",
"phone": "string",
"title": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/corrective-preventive-actions": {
"get": {
"tags": [
"Corrective Preventative Actions"
],
"summary": "Gets a list of corrective actions",
"description": "By default a corrective action response will include only the fields: authorization, uniqueID, carDate, carJobNumber, carPrinted, closeOutDate, correctiveActionCode, correctiveActionNumber, customerCode, customerPONumber, customerRMANumber, description, enterBy, enterDate, feedbackNumber, immediateAction, implementationDate, lastModDate, lastModUser, orderNumber, partNumber, permanentAction, PONumber, qualityControlManager, quantityReturned, quantityToRework, reasonForReturn, responseDue, returnType, rmaItemNumber, rootCause, signatureOnFile, status, vendorCode, vendorReturnNumber, vendorRMANumber, verificationBy, verificationDate, verificationOfEffectiveness, verificationOfEffectivenessBy, verificationOfImplementation. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Number": {
"value": {
"correctiveActionNumber": "1001"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrectiveActionListSuccessResponse"
},
"example": {
"Data": [
{
"authorization": "string",
"carDate": "2026-09-06T17:13:12.0000000+00:00",
"carJobNumber": "string",
"carPrinted": "string",
"closeOutDate": "2026-09-06T17:13:12.0000000+00:00",
"correctiveActionCode": "string",
"correctiveActionNumber": "string",
"customerCode": "string",
"customerPONumber": "string",
"customerRMANumber": "string",
"description": "string",
"enterBy": "string",
"enterDate": "2026-09-06T17:13:12.0000000+00:00",
"feedbackNumber": "string",
"immediateAction": "string",
"implementationDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"orderNumber": "string",
"partNumber": "string",
"permanentAction": "string",
"PONumber": "string",
"qualityControlManager": "string",
"quantityReturned": 0,
"quantityToRework": 0,
"reasonForReturn": "string",
"responseDue": "2026-09-06T17:13:12.0000000+00:00",
"returnType": "string",
"rmaItemNumber": 0,
"rootCause": "string",
"signatureOnFile": "string",
"status": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorReturnNumber": "string",
"vendorRMANumber": "string",
"verificationBy": "string",
"verificationDate": "2026-09-06T17:13:12.0000000+00:00",
"verificationOfEffectiveness": "string",
"verificationOfEffectivenessBy": "string",
"verificationOfImplementation": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/corrective-preventive-actions/{correctiveActionNumber}": {
"get": {
"tags": [
"Corrective Preventative Actions"
],
"summary": "Gets a corrective action by number",
"description": "By default a corrective action response will include only the fields: authorization, uniqueID, carDate, carJobNumber, carPrinted, closeOutDate, correctiveActionCode, correctiveActionNumber, customerCode, customerPONumber, customerRMANumber, description, enterBy, enterDate, feedbackNumber, immediateAction, implementationDate, lastModDate, lastModUser, orderNumber, partNumber, permanentAction, PONumber, qualityControlManager, quantityReturned, quantityToRework, reasonForReturn, responseDue, returnType, rmaItemNumber, rootCause, signatureOnFile, status, vendorCode, vendorReturnNumber, vendorRMANumber, verificationBy, verificationDate, verificationOfEffectiveness, verificationOfEffectivenessBy, verificationOfImplementation. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "correctiveActionNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrectiveActionSuccessResponse"
},
"example": {
"Data": {
"authorization": "string",
"carDate": "2026-09-06T17:13:12.0000000+00:00",
"carJobNumber": "string",
"carPrinted": "string",
"closeOutDate": "2026-09-06T17:13:12.0000000+00:00",
"correctiveActionCode": "string",
"correctiveActionNumber": "string",
"customerCode": "string",
"customerPONumber": "string",
"customerRMANumber": "string",
"description": "string",
"enterBy": "string",
"enterDate": "2026-09-06T17:13:12.0000000+00:00",
"feedbackNumber": "string",
"immediateAction": "string",
"implementationDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"orderNumber": "string",
"partNumber": "string",
"permanentAction": "string",
"PONumber": "string",
"qualityControlManager": "string",
"quantityReturned": 0,
"quantityToRework": 0,
"reasonForReturn": "string",
"responseDue": "2026-09-06T17:13:12.0000000+00:00",
"returnType": "string",
"rmaItemNumber": 0,
"rootCause": "string",
"signatureOnFile": "string",
"status": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorReturnNumber": "string",
"vendorRMANumber": "string",
"verificationBy": "string",
"verificationDate": "2026-09-06T17:13:12.0000000+00:00",
"verificationOfEffectiveness": "string",
"verificationOfEffectivenessBy": "string",
"verificationOfImplementation": "string"
}
}
}
}
}
}
}
},
"/api/v1/currency-codes": {
"get": {
"tags": [
"CurrencyCodes"
],
"summary": "Gets a list of Currency Codes",
"description": "By default a currency code response will include only the fields: accountingID, buyRate, currencyCode, uniqueID, currencyFormat, currencySymbol, dateEntered, decimalPlaces, decimalSymbol, description, enteredBy, formatShow, GLCode, lastModDate, lastModUser, negativeCurrencyFormat, negativeFormatShow, QBCurrencyCode, sellRate, thousandsSeparator. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by GL Code": {
"value": {
"GLCode": "4100"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyCodeListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"buyRate": 0,
"currencyCode": "string",
"currencyFormat": "string",
"currencySymbol": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"decimalPlaces": 0,
"decimalSymbol": "string",
"description": "string",
"enteredBy": "string",
"formatShow": "string",
"GLCode": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"negativeCurrencyFormat": "string",
"negativeFormatShow": "string",
"QBCurrencyCode": "string",
"sellRate": 0,
"thousandsSeparator": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/customer-return-line-items": {
"get": {
"tags": [
"Customer Return Line Items"
],
"summary": "Gets a list of Customer Return Line Items",
"description": "By default a customer return line item response will include only the fields: binLocation, correctiveActionNumber, createCAR, createNC, customerPONumber, customerRMANumber, deliveryTicketItemNumber, deliveryTicketNumber, description, lastModDate, lastModUser, lotNumber, ncNumber, originalJobNumber, originalOrderNumber, originalQuantityShipped, partDescription, partNumber, quantityGood, quantityReturned, quantityToRestock, quantityToRework, reasonCode, restockingPercent, reworkJobNumber, rmaItemNumber, status, uniqueID, unit. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by partNumber": {
"value": {
"partNumber": "1000"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerReturnLineItemListSuccessResponse"
},
"example": {
"Data": [
{
"binLocation": "string",
"correctiveActionNumber": "string",
"createCAR": "string",
"createNC": "string",
"customerPONumber": "string",
"customerRMANumber": "string",
"deliveryTicketItemNumber": 0,
"deliveryTicketNumber": "string",
"description": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"ncNumber": "string",
"originalJobNumber": "string",
"originalOrderNumber": "string",
"originalQuantityShipped": 0,
"partDescription": "string",
"partNumber": "string",
"quantityGood": 0,
"quantityReturned": 0,
"quantityToRestock": 0,
"quantityToRework": 0,
"reasonCode": "string",
"restockingPercent": 0,
"reworkJobNumber": "string",
"rmaItemNumber": 0,
"status": "string",
"uniqueID": 0,
"unit": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/customer-return-releases": {
"get": {
"tags": [
"Customer Return Releases"
],
"summary": "Gets a list of Customer Return Releases",
"description": "By default a customer return release response will include only the fields: binLocation, comments, customerRMANumber, lastModDate, lastModUser, lotNumber, quantityToRestock, quantityToRework, rmaItemNumber, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by lotNumber": {
"value": {
"lotNumber": "1"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerReturnReleaseApiListSuccessResponse"
},
"example": {
"Data": [
{
"binLocation": "string",
"comments": "string",
"customerRMANumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"quantityToRestock": 0,
"quantityToRework": 0,
"rmaItemNumber": 0,
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/customer-returns": {
"get": {
"tags": [
"Customer Returns"
],
"summary": "Gets a list of Customer Returns",
"description": "By default a customer return response will include only the fields: billCustomerForReturn, comment, correctiveActionCode, correctiveActionNumber, createCAR, createCreditMemo, createdInvoiceNumber, createNC, creditDate, creditedBy, customerCode, customerDescription, customerPONumber, customerRMANumber, dateEntered, debitPrinted, deliveryTicketNumber, enteredBy, inspectedBy, inspectionDate, issueDate, issuedBy, labelPrinted, lastModDate, lastModUser, orderDate, orderedBy, QCComment, reasonForReturn, receiveDate, receivedBy, receivingComment, status, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by customerCode": {
"value": {
"customerCode": "ALPHA"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerReturnListSuccessResponse"
},
"example": {
"Data": [
{
"billCustomerForReturn": "string",
"comment": "string",
"correctiveActionCode": "string",
"correctiveActionNumber": "string",
"createCAR": "string",
"createCreditMemo": "string",
"createdInvoiceNumber": "string",
"createNC": "string",
"creditDate": "2026-09-06T17:13:12.0000000+00:00",
"creditedBy": "string",
"customerCode": "string",
"customerDescription": "string",
"customerPONumber": "string",
"customerRMANumber": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"debitPrinted": "string",
"deliveryTicketNumber": "string",
"enteredBy": "string",
"inspectedBy": "string",
"inspectionDate": "2026-09-06T17:13:12.0000000+00:00",
"issueDate": "2026-09-06T17:13:12.0000000+00:00",
"issuedBy": "string",
"labelPrinted": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"orderDate": "2026-09-06T17:13:12.0000000+00:00",
"orderedBy": "string",
"QCComment": "string",
"reasonForReturn": "string",
"receiveDate": "2026-09-06T17:13:12.0000000+00:00",
"receivedBy": "string",
"receivingComment": "string",
"status": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/customers": {
"get": {
"tags": [
"Customers"
],
"summary": "Gets a list of Customers",
"description": "By default a customer response will include only the fields: active, APContact, creditLimit, currencyCode, customerCode, customerName, lastModDate, phone, salesID, termsCode, uniqueID, website, workCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by SalesID": {
"value": {
"salesID": "BOB"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"active": false,
"APContact": "string",
"APPhone": "string",
"averageDaysToPay": 0,
"averageReceiptAge": 0,
"billingAddress1": "string",
"billingCity": "string",
"billingCountry": "string",
"billingState": "string",
"billingZIPCode": "string",
"comments1": "string",
"comments2": "string",
"contact1": "string",
"contact1Phone": "string",
"contact2": "string",
"contact2Phone": "string",
"creditLimit": 0,
"creditStatus": "string",
"currencyCode": "string",
"currentReceivableBalance": 0,
"customerCode": "string",
"customerName": "string",
"dateLast": "2026-09-06T17:13:12.0000000+00:00",
"dateOpen": "2026-09-06T17:13:12.0000000+00:00",
"defaultPriority": 0,
"discountPercent": 0,
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"federalIDNumber": "string",
"GSTCode": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"minimumOrder": 0,
"NET1ContactID": "string",
"phone": "string",
"priceTier": 0,
"QBCustomerCode": "string",
"restockingPercent": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"salesID": "string",
"taxCode": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"website": "string",
"workCode": "string",
"YTDSales": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Customers"
],
"summary": "Creates a Customer",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCreate"
},
"example": {
"active": false,
"billingAddress1": "string",
"billingCity": "string",
"billingCountry": "string",
"billingState": "string",
"billingZIPCode": "string",
"comments1": "string",
"comments2": "string",
"creditLimit": 0,
"creditStatus": "string",
"currencyCode": "string",
"customerCode": "string",
"customerName": "string",
"defaultPriority": 0,
"discountPercent": 0,
"fax": "string",
"federalIDNumber": "string",
"GSTCode": "string",
"minimumOrder": 0,
"phone": "string",
"QBCustomerCode": "string",
"salesID": "string",
"taxCode": "string",
"termsCode": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"website": "string",
"workCode": "string",
"shippingAddresses": [
{
"location": "string",
"printCertification": false,
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingContact": "string",
"shippingCountry": "string",
"shippingFAX": "string",
"shippingPhone": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipToName": "string",
"shipVia": "string",
"territory": "string"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"example": {
"accountingID": "string",
"active": false,
"APContact": "string",
"APPhone": "string",
"averageDaysToPay": 0,
"averageReceiptAge": 0,
"billingAddress1": "string",
"billingCity": "string",
"billingCountry": "string",
"billingState": "string",
"billingZIPCode": "string",
"comments1": "string",
"comments2": "string",
"contact1": "string",
"contact1Phone": "string",
"contact2": "string",
"contact2Phone": "string",
"creditLimit": 0,
"creditStatus": "string",
"currencyCode": "string",
"currentReceivableBalance": 0,
"customerCode": "string",
"customerName": "string",
"dateLast": "2026-09-06T17:13:12.0000000+00:00",
"dateOpen": "2026-09-06T17:13:12.0000000+00:00",
"defaultPriority": 0,
"discountPercent": 0,
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"federalIDNumber": "string",
"GSTCode": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"minimumOrder": 0,
"NET1ContactID": "string",
"phone": "string",
"priceTier": 0,
"QBCustomerCode": "string",
"restockingPercent": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"salesID": "string",
"taxCode": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"website": "string",
"workCode": "string",
"YTDSales": 0
}
}
}
}
}
}
},
"/api/v1/customers/{customerCode}": {
"get": {
"tags": [
"Customers"
],
"summary": "Gets a Customer by customer code",
"description": "By default a customer response will include only the fields: active, APContact, creditLimit, currencyCode, customerCode, customerName, lastModDate, phone, salesID, termsCode, uniqueID, website, workCode. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "customerCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerSuccessResponse"
},
"example": {
"Data": {
"accountingID": "string",
"active": false,
"APContact": "string",
"APPhone": "string",
"averageDaysToPay": 0,
"averageReceiptAge": 0,
"billingAddress1": "string",
"billingCity": "string",
"billingCountry": "string",
"billingState": "string",
"billingZIPCode": "string",
"comments1": "string",
"comments2": "string",
"contact1": "string",
"contact1Phone": "string",
"contact2": "string",
"contact2Phone": "string",
"creditLimit": 0,
"creditStatus": "string",
"currencyCode": "string",
"currentReceivableBalance": 0,
"customerCode": "string",
"customerName": "string",
"dateLast": "2026-09-06T17:13:12.0000000+00:00",
"dateOpen": "2026-09-06T17:13:12.0000000+00:00",
"defaultPriority": 0,
"discountPercent": 0,
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"federalIDNumber": "string",
"GSTCode": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"minimumOrder": 0,
"NET1ContactID": "string",
"phone": "string",
"priceTier": 0,
"QBCustomerCode": "string",
"restockingPercent": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"salesID": "string",
"taxCode": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"website": "string",
"workCode": "string",
"YTDSales": 0
}
}
}
}
}
}
},
"patch": {
"tags": [
"Customers"
],
"summary": "Updates a Customer",
"parameters": [
{
"name": "customerCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerUpdate"
},
"example": {
"active": false,
"billingAddress1": "string",
"billingCity": "string",
"billingCountry": "string",
"billingState": "string",
"billingZIPCode": "string",
"comments1": "string",
"comments2": "string",
"creditLimit": 0,
"currencyCode": "string",
"customerName": "string",
"discountPercent": 0,
"federalIDNumber": "string",
"GSTCode": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"website": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/departments": {
"get": {
"tags": [
"Departments"
],
"summary": "Gets a list of Departments",
"description": "By default a department response will include only the fields: active, departmentNumber, description, lastModDate, lastModUser, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Active Status": {
"value": {
"active": "true"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"departmentNumber": "string",
"description": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/document-controls": {
"get": {
"tags": [
"Document Controls"
],
"summary": "Gets a list of Document Controls",
"description": "By default a document control response will include only the fields: approvalComments, approvalDate, approvedBy, dateEntered, description, documentDate, documentNumber, documentStatus, documentType, enteredBy, fileLocation, lastModDate, lastModUser, printed, proposalComments, proposalDate, proposedBy, releaseComments, releaseDate, releasedBy, repositoryID, retiredBy, retirementComments, retirementDate, revision, revisionDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentControlListSuccessResponse"
},
"example": {
"Data": [
{
"approvalComments": "string",
"approvalDate": "2026-09-06T17:13:12.0000000+00:00",
"approvedBy": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"description": "string",
"documentDate": "2026-09-06T17:13:12.0000000+00:00",
"documentNumber": "string",
"documentStatus": "string",
"documentType": "string",
"enteredBy": "string",
"fileLocation": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"printed": "string",
"proposalComments": "string",
"proposalDate": "2026-09-06T17:13:12.0000000+00:00",
"proposedBy": "string",
"releaseComments": "string",
"releaseDate": "2026-09-06T17:13:12.0000000+00:00",
"releasedBy": "string",
"repositoryID": 0,
"retiredBy": "string",
"retirementComments": "string",
"retirementDate": "2026-09-06T17:13:12.0000000+00:00",
"revision": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/document-histories": {
"get": {
"tags": [
"Document Histories"
],
"summary": "Gets a list of Document Histories",
"description": "By default a document history response will include only the fields: comments, documentNumber, fileLocation, repositoryID, revision, revisionDate, spunOffFile, uniqueID, updatedJobs, updatedParts, userID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Document Number": {
"value": {
"documentNumber": "1002"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentControlHistoryListSuccessResponse"
},
"example": {
"Data": [
{
"comments": "string",
"documentNumber": "string",
"fileLocation": "string",
"repositoryID": 0,
"revision": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"spunOffFile": "string",
"uniqueID": 0,
"updatedJobs": "string",
"updatedParts": "string",
"userID": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/document-review": {
"get": {
"tags": [
"Document Review"
],
"summary": "Gets a list of Document Review records",
"description": "By default a document review response will include only the fields: completed, cost, description, documentNumber, uniqueID, employeeCode, endDate, invoiceNumber, jobNumber, lastModDate, lastModUser, reviewCode, startDate, vendorCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Vendor Code": {
"value": {
"vendorCode": "EXAMPLE"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentReviewListSuccessResponse"
},
"example": {
"Data": [
{
"completed": "string",
"cost": 0,
"description": "string",
"documentNumber": "string",
"employeeCode": 0,
"endDate": "2026-09-06T17:13:12.0000000+00:00",
"invoiceNumber": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"reviewCode": "string",
"startDate": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0,
"vendorCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/employee-trainings": {
"get": {
"tags": [
"Employee Trainings"
],
"summary": "Gets a list of Employee Trainings",
"description": "By default an employee training response will include only the fields: completed, cost, description, employeeCode, employeeName, endDate, instructor, invoiceNumber, lastModDate, lastModUser, location, startDate, trainingCode, vendorCode, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Employee Code": {
"value": {
"employeeCode": "101"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeTrainingListSuccessResponse"
},
"example": {
"Data": [
{
"completed": false,
"cost": 0,
"description": "string",
"employeeCode": 0,
"employeeName": "string",
"endDate": "2026-09-06T17:13:12.0000000+00:00",
"instructor": "string",
"invoiceNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"startDate": "2026-09-06T17:13:12.0000000+00:00",
"trainingCode": "string",
"uniqueID": 0,
"vendorCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/employees": {
"get": {
"tags": [
"Employees"
],
"summary": "Gets a list of Employees",
"description": "By default an employee response will include only the fields: active, city, country, departmentNumber, employeeCode, employeeName, employeeShortName, lastModDate, phone, rate1, shiftID, state, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Department Number": {
"value": {
"departmentNumber": "TURNING"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"active": false,
"address1": "string",
"allowBatchAtClock": false,
"applyAutoBreak": false,
"break1Duration": 0,
"break1Time": "string",
"break2Duration": 0,
"break2Time": "string",
"break3Duration": 0,
"break3Time": "string",
"break4Duration": 0,
"break4Time": "string",
"city": "string",
"companyShipToLocation": "string",
"country": "string",
"defaultPayrollRate": 0,
"departmentNumber": "string",
"employeeCode": 0,
"employeeCodeImageFile": "string",
"employeeName": "string",
"employeeShortName": "string",
"geoFenceRadius": 0,
"hireDate": "2026-09-06T17:13:12.0000000+00:00",
"imageRepositoryID": 0,
"isDataCollectionUser": false,
"isGeoFenceEnabled": false,
"isSSIDFenceEnabled": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lastReview": "2026-09-06T17:13:12.0000000+00:00",
"nextReview": "2026-09-06T17:13:12.0000000+00:00",
"notes": "string",
"overtimeFactor": 0,
"overtimeMethod": "string",
"overtimeThreshold": 0,
"phone": "string",
"rate1": 0,
"rate10": 0,
"rate2": 0,
"rate3": 0,
"rate4": 0,
"rate5": 0,
"rate6": 0,
"rate7": 0,
"rate8": 0,
"rate9": 0,
"shiftBegin": "string",
"shiftEnd": "string",
"shiftID": 0,
"signatureImageFile": "string",
"signatureRepositoryID": 0,
"SSID": "string",
"state": "string",
"terminationDate": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"userID": "string",
"workFriday": false,
"workMonday": false,
"workSaturday": false,
"workSunday": false,
"workThursday": false,
"workTuesday": false,
"workWednesday": false,
"zipCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/employees/{employeeCode}": {
"patch": {
"tags": [
"Employees"
],
"summary": "Updates an Employee",
"parameters": [
{
"name": "employeeCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeUpdate"
},
"example": {
"departmentNumber": "string",
"employeeName": "string",
"rate1": 0,
"shiftID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/estimates": {
"get": {
"tags": [
"Estimates"
],
"summary": "Gets a list of Estimates",
"description": "By default an estimate response will include only the fields: active, alternatePartNumber, calculationMethod, comments, customerCode, description, GLCode, leadTime, partNumber, productCode, purchaseFactor, purchasingGLCode, purchasingUnit, quantityOnHandBinLocation, revision, stockingCost, uniqueID, vendorCode1. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Product Code": {
"value": {
"productCode": "JOBSHOP"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"active": false,
"alternatePartNumber": "string",
"billingRate": 0,
"bin1Lot": "string",
"bin2Lot": "string",
"bin3Lot": "string",
"bin4Lot": "string",
"bin5Lot": "string",
"binLocation1": "string",
"binLocation2": "string",
"binLocation3": "string",
"binLocation4": "string",
"binLocation5": "string",
"binQuantity1": 0,
"binQuantity2": 0,
"binQuantity3": 0,
"binQuantity4": 0,
"binQuantity5": 0,
"calculationMethod": "string",
"comments": "string",
"commissionPercent": 0,
"customerCode": "string",
"defaultBinLocation": "string",
"description": "string",
"drawingFileName": "string",
"drawingNumber": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"imageRepositoryID": 0,
"inspectCustomerReturns": false,
"inspectInternalRejections": false,
"inspectOrders": false,
"inspectReceivers": false,
"isTaxable": false,
"lastDeliveryTicketDate": "2026-09-06T17:13:12.0000000+00:00",
"lastDeliveryTicketNumber": "string",
"lastDeliveryTicketQuantity": 0,
"lastJobDate": "2026-09-06T17:13:12.0000000+00:00",
"lastJobDateFinished": "2026-09-06T17:13:12.0000000+00:00",
"lastJobNumber": "string",
"lastJobPrice": 0,
"lastJobQuantity": 0,
"lastJobQuoteNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lastPriceChange": "2026-09-06T17:13:12.0000000+00:00",
"lastPurchaseOrderCost": 0,
"lastPurchaseOrderDate": "2026-09-06T17:13:12.0000000+00:00",
"lastPurchaseOrderNumber": "string",
"lastPurchaseOrderQuantity": 0,
"leadTime": 0,
"lockPrice": false,
"markup1": 0,
"markup2": 0,
"markup3": 0,
"markup4": 0,
"markup5": 0,
"markup6": 0,
"markup7": 0,
"markup8": 0,
"markupPercent": 0,
"matchQuantityBreaks": false,
"miscCharge": 0,
"miscDescription": "string",
"partNumber": "string",
"partWeight": 0,
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"pricingUnit": "string",
"printed": false,
"productCode": "string",
"purchaseCost1": 0,
"purchaseCost2": 0,
"purchaseCost3": 0,
"purchaseCost4": 0,
"purchaseCost5": 0,
"purchaseCost6": 0,
"purchaseCost7": 0,
"purchaseCost8": 0,
"purchaseFactor": 0,
"purchaseQuantity1": 0,
"purchaseQuantity2": 0,
"purchaseQuantity3": 0,
"purchaseQuantity4": 0,
"purchaseQuantity5": 0,
"purchaseQuantity6": 0,
"purchaseQuantity7": 0,
"purchaseQuantity8": 0,
"purchasingGLCode": "string",
"purchasingUnit": "string",
"QBItemType": "string",
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"quantityOnHand": "string",
"quantityOnOrder": 0,
"quantityOutside": 0,
"reOrderLevel": 0,
"reOrderQuantity": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"revision": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"routeDate": "2026-09-06T17:13:12.0000000+00:00",
"routeEmployee": "string",
"stockingCost": 0,
"stockUnit": "string",
"uniqueID": 0,
"useDefaultQuantities": false,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorCode1": "string",
"vendorCode2": "string",
"vendorCode3": "string"
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Estimates"
],
"summary": "Creates an Estimate.",
"description": "**Quantity breaks** *Note: If you set 'useDefaultQuantities' flag to true the new estimate will use the default quantity breaks from company maintenance and if it is false the new estimate will ignore the default quantity breaks values so all quantities that are not in the request will be 0.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCreate"
},
"example": {
"active": false,
"alternatePartNumber": "string",
"calculationMethod": "string",
"customerCode": "string",
"description": "string",
"GLCode": "string",
"leadTime": 0,
"lockPrice": false,
"markup1": 0,
"markup2": 0,
"markup3": 0,
"markup4": 0,
"markup5": 0,
"markup6": 0,
"markup7": 0,
"markup8": 0,
"partNumber": "string",
"partWeight": 0,
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"pricingUnit": "string",
"productCode": "string",
"purchaseCost1": 0,
"purchaseCost2": 0,
"purchaseCost3": 0,
"purchaseCost4": 0,
"purchaseCost5": 0,
"purchaseCost6": 0,
"purchaseCost7": 0,
"purchaseCost8": 0,
"purchaseFactor": 0,
"purchaseQuantity1": 0,
"purchaseQuantity2": 0,
"purchaseQuantity3": 0,
"purchaseQuantity4": 0,
"purchaseQuantity5": 0,
"purchaseQuantity6": 0,
"purchaseQuantity7": 0,
"purchaseQuantity8": 0,
"purchasingGLCode": "string",
"purchasingUnit": "string",
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"revision": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"useDefaultQuantities": false,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorCode1": "string",
"materials": [
{
"description": "string",
"materialDetailID": "string",
"partWeight": 0,
"quantity": 0,
"stepNumber": 0,
"subPartNumber": "string",
"unit": "string",
"unitCost": 0,
"unitPrice": 0,
"vendor": "string"
}
],
"routings": [
{
"cycleTime": 0,
"cycleUnit": "string",
"description": "string",
"operatorCode": "string",
"setupTime": 0,
"stepNumber": 0,
"timeUnit": "string",
"vendorCode": "string",
"workCenter": "string",
"workOrVendor": "string"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Estimate"
},
"example": {
"accountingID": "string",
"active": false,
"alternatePartNumber": "string",
"billingRate": 0,
"bin1Lot": "string",
"bin2Lot": "string",
"bin3Lot": "string",
"bin4Lot": "string",
"bin5Lot": "string",
"binLocation1": "string",
"binLocation2": "string",
"binLocation3": "string",
"binLocation4": "string",
"binLocation5": "string",
"binQuantity1": 0,
"binQuantity2": 0,
"binQuantity3": 0,
"binQuantity4": 0,
"binQuantity5": 0,
"calculationMethod": "string",
"comments": "string",
"commissionPercent": 0,
"customerCode": "string",
"defaultBinLocation": "string",
"description": "string",
"drawingFileName": "string",
"drawingNumber": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"imageRepositoryID": 0,
"inspectCustomerReturns": false,
"inspectInternalRejections": false,
"inspectOrders": false,
"inspectReceivers": false,
"isTaxable": false,
"lastDeliveryTicketDate": "2026-09-06T17:13:12.0000000+00:00",
"lastDeliveryTicketNumber": "string",
"lastDeliveryTicketQuantity": 0,
"lastJobDate": "2026-09-06T17:13:12.0000000+00:00",
"lastJobDateFinished": "2026-09-06T17:13:12.0000000+00:00",
"lastJobNumber": "string",
"lastJobPrice": 0,
"lastJobQuantity": 0,
"lastJobQuoteNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lastPriceChange": "2026-09-06T17:13:12.0000000+00:00",
"lastPurchaseOrderCost": 0,
"lastPurchaseOrderDate": "2026-09-06T17:13:12.0000000+00:00",
"lastPurchaseOrderNumber": "string",
"lastPurchaseOrderQuantity": 0,
"leadTime": 0,
"lockPrice": false,
"markup1": 0,
"markup2": 0,
"markup3": 0,
"markup4": 0,
"markup5": 0,
"markup6": 0,
"markup7": 0,
"markup8": 0,
"markupPercent": 0,
"matchQuantityBreaks": false,
"miscCharge": 0,
"miscDescription": "string",
"partNumber": "string",
"partWeight": 0,
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"pricingUnit": "string",
"printed": false,
"productCode": "string",
"purchaseCost1": 0,
"purchaseCost2": 0,
"purchaseCost3": 0,
"purchaseCost4": 0,
"purchaseCost5": 0,
"purchaseCost6": 0,
"purchaseCost7": 0,
"purchaseCost8": 0,
"purchaseFactor": 0,
"purchaseQuantity1": 0,
"purchaseQuantity2": 0,
"purchaseQuantity3": 0,
"purchaseQuantity4": 0,
"purchaseQuantity5": 0,
"purchaseQuantity6": 0,
"purchaseQuantity7": 0,
"purchaseQuantity8": 0,
"purchasingGLCode": "string",
"purchasingUnit": "string",
"QBItemType": "string",
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"quantityOnHand": "string",
"quantityOnOrder": 0,
"quantityOutside": 0,
"reOrderLevel": 0,
"reOrderQuantity": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"revision": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"routeDate": "2026-09-06T17:13:12.0000000+00:00",
"routeEmployee": "string",
"stockingCost": 0,
"stockUnit": "string",
"uniqueID": 0,
"useDefaultQuantities": false,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorCode1": "string",
"vendorCode2": "string",
"vendorCode3": "string"
}
}
}
}
}
}
},
"/api/v1/estimates/{partNumber}": {
"get": {
"tags": [
"Estimates"
],
"summary": "Gets an Estimate by part number",
"description": "By default an estimate response will include only the fields: active, alternatePartNumber, calculationMethod, comments, customerCode, description, GLCode, leadTime, partNumber, productCode, purchaseFactor, purchasingGLCode, purchasingUnit, quantityOnHandBinLocation, revision, stockingCost, uniqueID, vendorCode1. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "partNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateSuccessResponse"
},
"example": {
"Data": {
"accountingID": "string",
"active": false,
"alternatePartNumber": "string",
"billingRate": 0,
"bin1Lot": "string",
"bin2Lot": "string",
"bin3Lot": "string",
"bin4Lot": "string",
"bin5Lot": "string",
"binLocation1": "string",
"binLocation2": "string",
"binLocation3": "string",
"binLocation4": "string",
"binLocation5": "string",
"binQuantity1": 0,
"binQuantity2": 0,
"binQuantity3": 0,
"binQuantity4": 0,
"binQuantity5": 0,
"calculationMethod": "string",
"comments": "string",
"commissionPercent": 0,
"customerCode": "string",
"defaultBinLocation": "string",
"description": "string",
"drawingFileName": "string",
"drawingNumber": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"imageRepositoryID": 0,
"inspectCustomerReturns": false,
"inspectInternalRejections": false,
"inspectOrders": false,
"inspectReceivers": false,
"isTaxable": false,
"lastDeliveryTicketDate": "2026-09-06T17:13:12.0000000+00:00",
"lastDeliveryTicketNumber": "string",
"lastDeliveryTicketQuantity": 0,
"lastJobDate": "2026-09-06T17:13:12.0000000+00:00",
"lastJobDateFinished": "2026-09-06T17:13:12.0000000+00:00",
"lastJobNumber": "string",
"lastJobPrice": 0,
"lastJobQuantity": 0,
"lastJobQuoteNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lastPriceChange": "2026-09-06T17:13:12.0000000+00:00",
"lastPurchaseOrderCost": 0,
"lastPurchaseOrderDate": "2026-09-06T17:13:12.0000000+00:00",
"lastPurchaseOrderNumber": "string",
"lastPurchaseOrderQuantity": 0,
"leadTime": 0,
"lockPrice": false,
"markup1": 0,
"markup2": 0,
"markup3": 0,
"markup4": 0,
"markup5": 0,
"markup6": 0,
"markup7": 0,
"markup8": 0,
"markupPercent": 0,
"matchQuantityBreaks": false,
"miscCharge": 0,
"miscDescription": "string",
"partNumber": "string",
"partWeight": 0,
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"pricingUnit": "string",
"printed": false,
"productCode": "string",
"purchaseCost1": 0,
"purchaseCost2": 0,
"purchaseCost3": 0,
"purchaseCost4": 0,
"purchaseCost5": 0,
"purchaseCost6": 0,
"purchaseCost7": 0,
"purchaseCost8": 0,
"purchaseFactor": 0,
"purchaseQuantity1": 0,
"purchaseQuantity2": 0,
"purchaseQuantity3": 0,
"purchaseQuantity4": 0,
"purchaseQuantity5": 0,
"purchaseQuantity6": 0,
"purchaseQuantity7": 0,
"purchaseQuantity8": 0,
"purchasingGLCode": "string",
"purchasingUnit": "string",
"QBItemType": "string",
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"quantityOnHand": "string",
"quantityOnOrder": 0,
"quantityOutside": 0,
"reOrderLevel": 0,
"reOrderQuantity": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"revision": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"routeDate": "2026-09-06T17:13:12.0000000+00:00",
"routeEmployee": "string",
"stockingCost": 0,
"stockUnit": "string",
"uniqueID": 0,
"useDefaultQuantities": false,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorCode1": "string",
"vendorCode2": "string",
"vendorCode3": "string"
}
}
}
}
}
}
},
"patch": {
"tags": [
"Estimates"
],
"summary": "Updates an Estimate",
"parameters": [
{
"name": "partNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateUpdate"
},
"example": {
"revision": "string",
"description": "string",
"revisionDate": "2026-09-06T17:13:12.0000000+00:00",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/feedback": {
"get": {
"tags": [
"Feedback"
],
"summary": "Gets a list of Feedback",
"description": "By default a feedback response will include only the fields: closeOut, closeOutDate, comments, contact, correctiveActionCode, createCAR, customerCode, customerPONumber, customerRMANumber, employeeCode, enterBy, enterDate, fax, feedbackCode, feedbackDate, feedbackNo, feedbackType, lastModDate, lastModUser, managerCloseOut, orderNumber, phone, resolution, status, uniqueID, vendorCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Feedback Type": {
"value": {
"feedbackType": "POSITIVE"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackListSuccessResponse"
},
"example": {
"Data": [
{
"closeOut": "string",
"closeOutDate": "2026-09-06T17:13:12.0000000+00:00",
"comments": "string",
"contact": "string",
"correctiveActionCode": "string",
"createCAR": "string",
"customerCode": "string",
"customerPONumber": "string",
"customerRMANumber": "string",
"employeeCode": "string",
"enterBy": "string",
"enterDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"feedbackCode": "string",
"feedbackDate": "2026-09-06T17:13:12.0000000+00:00",
"feedbackNo": "string",
"feedbackType": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"managerCloseOut": "string",
"orderNumber": "string",
"phone": "string",
"resolution": "string",
"status": "string",
"uniqueID": 0,
"vendorCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/gl-codes": {
"get": {
"tags": [
"GL Codes"
],
"summary": "Gets a list of GL Codes",
"description": "By default a GL Account response will include only the fields: accountingID, accountingCode, accumulationAccount, active, currencyCode, description, division, GLAccountNumber, lastModDate, lastModUser, uniqueID, vendorCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Account Code": {
"value": {
"accountingCode": "30"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GLAccountListSuccessResponse"
},
"example": {
"Data": [
{
"accountingCode": "string",
"accountingID": "string",
"accumulationAccount": "string",
"active": false,
"currencyCode": "string",
"description": "string",
"division": 0,
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"GLAccountNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0,
"vendorCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/gl-codes/{GLAccountNumber}": {
"get": {
"tags": [
"GL Codes"
],
"summary": "Gets a GL Code by GL Account Number",
"description": "By default a GL Account response will include only the fields: accountingID, accountingCode, accumulationAccount, active, currencyCode, description, division, GLAccountNumber, lastModDate, lastModUser, uniqueID, vendorCode. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "GLAccountNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GLAccountSuccessResponse"
},
"example": {
"Data": {
"accountingCode": "string",
"accountingID": "string",
"accumulationAccount": "string",
"active": false,
"currencyCode": "string",
"description": "string",
"division": 0,
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"GLAccountNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0,
"vendorCode": "string"
}
}
}
}
}
}
}
},
"/api/v1/issuing-materials/bin-locations": {
"get": {
"tags": [
"Issuing Materials"
],
"summary": "Gets a list of parts with bin locations and quantity on hand",
"description": "Returns inventory bin location records including part number, bin location, quantity on hand, cost, and related fields. Use the fields, sort, filter, skip, and take query parameters for customization. Filter by partNumber to get bin locations for a specific part.",
"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 fields to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expression section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Part Number": {
"value": {
"partNumber": "PART001"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/issuing-materials/job-numbers": {
"get": {
"tags": [
"Issuing Materials"
],
"summary": "Gets a list of job numbers",
"description": "Returns job numbers from order line items with standard fields and filtering. By default returns: jobNumber, partNumber, partDescription, status, dueDate, orderNumber. Use the fields, sort, filter, skip, and take query parameters for customization.",
"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 fields to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expression section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Status": {
"value": {
"status": "Open"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/issuing-materials/routing-steps": {
"get": {
"tags": [
"Issuing Materials"
],
"summary": "Gets a list of routing steps for jobs",
"description": "Returns routing steps from order routing records with standard fields and filtering. By default returns: jobNumber, stepNumber, operationCode, description, workCenter, status. Use the fields, sort, filter, skip, and take query parameters for customization. Filter by jobNumber to get routing steps for a specific job.",
"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 fields to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expression section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Job Number": {
"value": {
"jobNumber": "1234-1"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/issuing-materials/stock-to-job-transfer": {
"post": {
"tags": [
"Issuing Materials"
],
"summary": "Transfer stock materials to a job",
"description": "Transfers inventory from stock bin locations to a specified job. Creates JobMaterial records, adjusts bin quantities, logs inventory transactions, and recreates JobReq records for any remaining unfulfilled quantities. Set allowClosedJobs to true to allow transfers to closed jobs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockToJobTransferCreate"
},
"example": {
"jobNumber": "string",
"postingEffectiveDate": "2026-03-17",
"allowClosedJobs": false,
"materials": [
{
"partNumber": "string",
"quantityToMake": 0,
"stepNo": 0,
"bins": [
{
"binLocationId": 0,
"binLocation": "string",
"qty2Use": 0
}
]
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockToJobTransferResultSuccessResponse"
},
"example": {
"Data": {
"jobNumber": "string",
"materials": [
{
"partNumber": "string",
"quantityRequested": 0,
"quantityTransferred": 0,
"quantityCapped": 0,
"quantityRemainingToBuy": 0
}
],
"warnings": [ ]
}
}
}
}
}
}
}
},
"/api/v1/job-materials": {
"get": {
"tags": [
"Job Materials"
],
"summary": "Gets a list of Job Materials",
"description": "By default a job requirement response will include the fields: binLocation1, binLocation2, binLocation3, binLocation4, binLocation5, binLocationCounter, datePosted, description, GLCode, jobNumber, lastModDate, lastModUser, lotNumber1, lotNumber2, lotNumber3, lotNumber4, lotNumber5, mainPart, manufacturingJobNumber, orderNumber, originalBinCost, outsideService, packingListDate, packingListNumber, partNumber, PODate, POItemNumber, PONumber, postedBy, postedFromStock, pricingUnit, productCode, quantityPosted1, quantityPosted2, quantityPosted3, quantityPosted4, quantityPosted5, receiverDate, receiverNumber, resalePrice, stepNumber, stockingCost, stockUnit, subAssemblyJobNumber, uniqueID, vendorCode, vendorInvoiceNumber, vendorType. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Order Number": {
"value": {
"orderNumber": "7082"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobMaterialListSuccessResponse"
},
"example": {
"Data": [
{
"binLocation1": "string",
"binLocation2": "string",
"binLocation3": "string",
"binLocation4": "string",
"binLocation5": "string",
"binLocationCounter": 0,
"datePosted": "2026-09-06T17:13:12.0000000+00:00",
"description": "string",
"GLCode": "string",
"jobClosedDate": "2026-09-06T17:13:12.0000000+00:00",
"jobStatus": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber1": "string",
"lotNumber2": "string",
"lotNumber3": "string",
"lotNumber4": "string",
"lotNumber5": "string",
"mainPart": false,
"manufacturingJobNumber": "string",
"orderNumber": "string",
"originalBinCost": 0,
"outsideService": false,
"packingListDate": "2026-09-06T17:13:12.0000000+00:00",
"packingListNumber": "string",
"partNumber": "string",
"PODate": "2026-09-06T17:13:12.0000000+00:00",
"POItemNumber": 0,
"PONumber": "string",
"postedBy": "string",
"postedFromStock": false,
"pricingUnit": "string",
"productCode": "string",
"quantityPosted1": 0,
"quantityPosted2": 0,
"quantityPosted3": 0,
"quantityPosted4": 0,
"quantityPosted5": 0,
"receiverDate": "2026-09-06T17:13:12.0000000+00:00",
"receiverNumber": "string",
"resalePrice": 0,
"stepNumber": 0,
"stockingCost": 0,
"stockUnit": "string",
"subAssemblyJobNumber": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorInvoiceNumber": "string",
"vendorType": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/job-materials/{uniqueID}": {
"get": {
"tags": [
"Job Materials"
],
"summary": "Gets a Job Material by unique ID",
"description": "By default a job material response will include the fields: binLocation1, binLocation2, binLocation3, binLocation4, binLocation5, binLocationCounter, datePosted, description, GLCode, jobNumber, lastModDate, lastModUser, lotNumber1, lotNumber2, lotNumber3, lotNumber4, lotNumber5, mainPart, manufacturingJobNumber, orderNumber, originalBinCost, outsideService, packingListDate, packingListNumber, partNumber, PODate, POItemNumber, PONumber, postedBy, postedFromStock, pricingUnit, productCode, quantityPosted1, quantityPosted2, quantityPosted3, quantityPosted4, quantityPosted5, receiverDate, receiverNumber, resalePrice, stepNumber, stockingCost, stockUnit, subAssemblyJobNumber, uniqueID, vendorCode, vendorInvoiceNumber, vendorType. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "uniqueID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobMaterialSuccessResponse"
},
"example": {
"Data": {
"binLocation1": "string",
"binLocation2": "string",
"binLocation3": "string",
"binLocation4": "string",
"binLocation5": "string",
"binLocationCounter": 0,
"datePosted": "2026-09-06T17:13:12.0000000+00:00",
"description": "string",
"GLCode": "string",
"jobClosedDate": "2026-09-06T17:13:12.0000000+00:00",
"jobStatus": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber1": "string",
"lotNumber2": "string",
"lotNumber3": "string",
"lotNumber4": "string",
"lotNumber5": "string",
"mainPart": false,
"manufacturingJobNumber": "string",
"orderNumber": "string",
"originalBinCost": 0,
"outsideService": false,
"packingListDate": "2026-09-06T17:13:12.0000000+00:00",
"packingListNumber": "string",
"partNumber": "string",
"PODate": "2026-09-06T17:13:12.0000000+00:00",
"POItemNumber": 0,
"PONumber": "string",
"postedBy": "string",
"postedFromStock": false,
"pricingUnit": "string",
"productCode": "string",
"quantityPosted1": 0,
"quantityPosted2": 0,
"quantityPosted3": 0,
"quantityPosted4": 0,
"quantityPosted5": 0,
"receiverDate": "2026-09-06T17:13:12.0000000+00:00",
"receiverNumber": "string",
"resalePrice": 0,
"stepNumber": 0,
"stockingCost": 0,
"stockUnit": "string",
"subAssemblyJobNumber": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorInvoiceNumber": "string",
"vendorType": "string"
}
}
}
}
}
}
}
},
"/api/v1/job-requirements": {
"get": {
"tags": [
"Job Requirements"
],
"summary": "Gets a list of Job Requirements",
"description": "By default a job requirement response will include only the fields: certificationRequired, cost, dateProcessed, GLCode, jobDue, jobNumber, uniqueID, lastModDate, lastModUser, leadTime, orderNumber, outsideService, partDescription, partNumber, PODate, POItemNumber, PONumber, price, pricingUnit, productCode, purchaseQuantity, purchaseUnit, quantityToBuy, setupCharge, stepNumber, stockingUnit, temporaryJobDue, vendorCode, workCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Order Number": {
"value": {
"orderNumber": "7082"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobRequirementListSuccessResponse"
},
"example": {
"Data": [
{
"certificationRequired": false,
"cost": 0,
"dateProcessed": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"jobDue": "2026-09-06T17:13:12.0000000+00:00",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"orderNumber": "string",
"outsideService": false,
"partDescription": "string",
"partNumber": "string",
"PODate": "2026-09-06T17:13:12.0000000+00:00",
"POItemNumber": 0,
"PONumber": "string",
"price": 0,
"pricingUnit": "string",
"productCode": "string",
"purchaseQuantity": 0,
"purchaseUnit": "string",
"quantityToBuy": 0,
"setupCharge": 0,
"stepNumber": 0,
"stockingUnit": "string",
"temporaryJobDue": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0,
"vendorCode": "string",
"workCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/job-requirements/{uniqueID}": {
"get": {
"tags": [
"Job Requirements"
],
"summary": "Gets a Job Requirement by uniqueID",
"description": "By default a job requirement response will include only the fields: certificationRequired, cost, dateProcessed, GLCode, jobDue, jobNumber, uniqueID, lastModDate, lastModUser, leadTime, orderNumber, outsideService, partDescription, partNumber, PODate, POItemNumber, PONumber, price, pricingUnit, productCode, purchaseQuantity, purchaseUnit, quantityToBuy, setupCharge, stepNumber, stockingUnit, temporaryJobDue, vendorCode, workCode. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "uniqueID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobRequirementSuccessResponse"
},
"example": {
"Data": {
"certificationRequired": false,
"cost": 0,
"dateProcessed": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"jobDue": "2026-09-06T17:13:12.0000000+00:00",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"orderNumber": "string",
"outsideService": false,
"partDescription": "string",
"partNumber": "string",
"PODate": "2026-09-06T17:13:12.0000000+00:00",
"POItemNumber": 0,
"PONumber": "string",
"price": 0,
"pricingUnit": "string",
"productCode": "string",
"purchaseQuantity": 0,
"purchaseUnit": "string",
"quantityToBuy": 0,
"setupCharge": 0,
"stepNumber": 0,
"stockingUnit": "string",
"temporaryJobDue": "2026-09-06T17:13:12.0000000+00:00",
"uniqueID": 0,
"vendorCode": "string",
"workCode": "string"
}
}
}
}
}
}
}
},
"/api/v1/estimates/{partNumber}/materials/{subPartNumber}": {
"get": {
"tags": [
"Materials"
],
"summary": "Gets a Material of an Estimate by part number and sub part number",
"description": "By default a material response will include only the fields: description, itemNumber, lastModDate, lastModUser, uniqueID, partNumber, partWeight, isPurchased, quantity, stepNumber, subPartNumber, totalCost, totalPrice, totalQuantity, totalWeight, unit, unitCost, unitPrice, vendor, materialDetailID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "partNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subPartNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialSuccessResponse"
},
"example": {
"Data": {
"description": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"isPurchased": false,
"itemNumber": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"materialDetailID": "string",
"partNumber": "string",
"partWeight": 0,
"quantity": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"stepNumber": 0,
"subPartNumber": "string",
"totalCost": 0,
"totalPrice": 0,
"totalQuantity": 0,
"totalWeight": 0,
"uniqueID": 0,
"unit": "string",
"unitCost": 0,
"unitPrice": 0,
"vendor": "string"
}
}
}
}
}
}
}
},
"/api/v1/materials": {
"get": {
"tags": [
"Materials"
],
"summary": "Gets a list of Materials",
"description": "By default a material response will include only the fields: description, itemNumber, lastModDate, lastModUser, uniqueID, partNumber, partWeight, isPurchased, quantity, stepNumber, subPartNumber, totalCost, totalPrice, totalQuantity, totalWeight, unit, unitCost, unitPrice, vendor, materialDetailID. You may specify the exact fields to return using the fields parameter.",
"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 fields to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expression section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Vendor": {
"value": {
"vendor": "PLASTIC"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialListSuccessResponse"
},
"example": {
"Data": [
{
"description": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"isPurchased": false,
"itemNumber": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"materialDetailID": "string",
"partNumber": "string",
"partWeight": 0,
"quantity": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"stepNumber": 0,
"subPartNumber": "string",
"totalCost": 0,
"totalPrice": 0,
"totalQuantity": 0,
"totalWeight": 0,
"uniqueID": 0,
"unit": "string",
"unitCost": 0,
"unitPrice": 0,
"vendor": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/non-conformances": {
"get": {
"tags": [
"Non Conformances"
],
"summary": "Gets a list of Non-Conformances",
"description": "By default a non-conformance response will include only the fields: comment, correctiveActionNumber, customerCode, customerPONumber, department, disposition, employeeCode, enterBy, enterDate, inspectedBy, jobNumber, lastModDate, lastModUser, lotNumber, ncDescription, ncPrinted, ncCode, ncDate, ncNumber, uniqueID, orderNumber, other, partDescription, partNumber, poNumber, processDate, quantityReturned, quantity, reasonCode, responsibleMgr, returnItemNumber, returnNumber, returnType, status, vendorCode, vendorRMANumber. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Number": {
"value": {
"ncNumber": "1000"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NonConformanceListSuccessResponse"
},
"example": {
"Data": [
{
"comment": "string",
"correctiveActionNumber": "string",
"customerCode": "string",
"customerPONumber": "string",
"department": "string",
"disposition": "string",
"employeeCode": "string",
"enterBy": "string",
"enterDate": "2026-09-06T17:13:12.0000000+00:00",
"inspectedBy": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"ncCode": "string",
"ncDate": "2026-09-06T17:13:12.0000000+00:00",
"ncDescription": "string",
"ncNumber": "string",
"ncPrinted": "string",
"orderNumber": "string",
"other": "string",
"partDescription": "string",
"partNumber": "string",
"poNumber": "string",
"processDate": "2026-09-06T17:13:12.0000000+00:00",
"quantity": 0,
"quantityReturned": 0,
"reasonCode": "string",
"responsibleMgr": "string",
"returnItemNumber": 0,
"returnNumber": "string",
"returnType": "string",
"status": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorRMANumber": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/non-conformances/{ncNumber}": {
"get": {
"tags": [
"Non Conformances"
],
"summary": "Gets Non-Conformance by number",
"description": "By default a non-conformance response will include only the fields: comment, correctiveActionNumber, customerCode, customerPONumber, department, disposition, employeeCode, enterBy, enterDate, inspectedBy, jobNumber, lastModDate, lastModUser, lotNumber, ncDescription, ncPrinted, ncCode, ncDate, ncNumber, uniqueID, orderNumber, other, partDescription, partNumber, poNumber, processDate, quantityReturned, quantity, reasonCode, responsibleMgr, returnItemNumber, returnNumber, returnType, status, vendorCode, vendorRMANumber. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "ncNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NonConformanceSuccessResponse"
},
"example": {
"Data": {
"comment": "string",
"correctiveActionNumber": "string",
"customerCode": "string",
"customerPONumber": "string",
"department": "string",
"disposition": "string",
"employeeCode": "string",
"enterBy": "string",
"enterDate": "2026-09-06T17:13:12.0000000+00:00",
"inspectedBy": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"ncCode": "string",
"ncDate": "2026-09-06T17:13:12.0000000+00:00",
"ncDescription": "string",
"ncNumber": "string",
"ncPrinted": "string",
"orderNumber": "string",
"other": "string",
"partDescription": "string",
"partNumber": "string",
"poNumber": "string",
"processDate": "2026-09-06T17:13:12.0000000+00:00",
"quantity": 0,
"quantityReturned": 0,
"reasonCode": "string",
"responsibleMgr": "string",
"returnItemNumber": 0,
"returnNumber": "string",
"returnType": "string",
"status": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorRMANumber": "string"
}
}
}
}
}
}
}
},
"/api/v1/operation-codes": {
"get": {
"tags": [
"Operation Codes"
],
"summary": "Gets a list of Operation Codes",
"description": "By default an operation code response will include only the fields: active, defaultCycleTime, defaultCycleUnit, defaultSetupTime, defaultTimeUnit, description, isUnattendedOperation, lastModDate, lastModUser, machinesRunByOperator, machinesJobRunOn, operationCode, uniqueID, operationNumber, percentEfficiency, scrapPercent, teamSize. You may specify the exact fields to return using the fields parameter.",
"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 fields to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expression section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Code": {
"value": {
"operationCode": "SAW"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationCodeListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"defaultCycleTime": 0,
"defaultCycleUnit": "string",
"defaultSetupTime": 0,
"defaultTimeUnit": "string",
"description": "string",
"isUnattendedOperation": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"machinesJobRunOn": 0,
"machinesRunByOperator": 0,
"operationCode": "string",
"operationNumber": 0,
"percentEfficiency": 0,
"scrapPercent": 0,
"teamSize": 0,
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/operation-codes/{operationCode}": {
"get": {
"tags": [
"Operation Codes"
],
"summary": "Gets an Operation Code by operation code",
"description": "By default an operation code response will include only the fields: active, defaultCycleTime, defaultCycleUnit, defaultSetupTime, defaultTimeUnit, description, isUnattendedOperation, lastModDate, lastModUser, machinesRunByOperator, machinesJobRunOn, operationCode, uniqueID, operationNumber, percentEfficiency, scrapPercent, teamSize. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "operationCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationCodeSuccessResponse"
},
"example": {
"Data": {
"active": false,
"defaultCycleTime": 0,
"defaultCycleUnit": "string",
"defaultSetupTime": 0,
"defaultTimeUnit": "string",
"description": "string",
"isUnattendedOperation": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"machinesJobRunOn": 0,
"machinesRunByOperator": 0,
"operationCode": "string",
"operationNumber": 0,
"percentEfficiency": 0,
"scrapPercent": 0,
"teamSize": 0,
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/order-line-items": {
"get": {
"tags": [
"Order Line Items"
],
"summary": "Gets a list of Order Line Items",
"description": "By default an order line item response will include only the fields: actualEndDate, actualStartDate, dateFinished, dueDate, estimatedEndDate, estimatedStartDate, itemNumber, jobNotes, jobNumber, masterJobNumber, orderNumber, partDescription, partNumber, pricingUnit, productCode, quantityCanceled, quantityOrdered, quantityShippedToCustomer, quantityShippedToStock, quantityToMake, quantityToStock, revision, status, totalActualHours, totalEstimatedHours, uniqueID, unitPrice, unitPriceForeign, workCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Order": {
"value": {
"orderNumber": "4370"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderLineItemListSuccessResponse"
},
"example": {
"Data": [
{
"actualEndDate": "2026-09-06T17:13:12.0000000+00:00",
"actualStartDate": "2026-09-06T17:13:12.0000000+00:00",
"billingRate": 0,
"commissionPercent": 0,
"cumulativeBilling": 0,
"currentWorkCenter": "string",
"dateFinished": "2026-09-06T17:13:12.0000000+00:00",
"discountPercent": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"FOB": "string",
"isJobLabelPrinted": false,
"isScheduled": false,
"isTaxable": false,
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"jobOnHold": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"masterJobNumber": "string",
"masterStepNumber": 0,
"miscCharges": 0,
"miscChargesBilled": false,
"miscChargesForeign": 0,
"miscDescription": "string",
"orderNumber": "string",
"overlapSteps": false,
"partDescription": "string",
"partNumber": "string",
"pricingUnit": "string",
"priority": 0,
"productCode": "string",
"quantityCanceled": 0,
"quantityOrdered": 0,
"quantityShippedToCustomer": 0,
"quantityShippedToStock": 0,
"quantityToMake": 0,
"quantityToStock": 0,
"quoteItemNumber": 0,
"quoteNumber": "string",
"revision": "string",
"scheduleLocked": false,
"status": "string",
"tempPriority": 0,
"totalActualHours": 0,
"totalEstimatedHours": 0,
"travelerPrinted": false,
"uniqueID": 0,
"unitPrice": 0,
"unitPriceForeign": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}/order-line-items": {
"post": {
"tags": [
"Order Line Items"
],
"summary": "Creates an order line item.",
"description": "**Parts from Quotes** *Note: If you add a new line where has a Quote asociated(quoteNumber, quoteItemNumber) then Part Description, Revision, Product Code and Work Code will be set from the quote and will ignore these fields from the request.",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderLineItemCreate"
},
"example": {
"billingRate": 0,
"commissionPercent": 0,
"discountPercent": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"FOB": "string",
"isTaxable": false,
"jobNotes": "string",
"miscCharges": 0,
"miscDescription": "string",
"partDescription": "string",
"partNumber": "string",
"pricingUnit": "string",
"priority": 0,
"productCode": "string",
"quantityOrdered": 0,
"quoteItemNumber": 0,
"quoteNumber": "string",
"revision": "string",
"totalEstimatedHours": 0,
"unitPrice": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string",
"releases": [
{
"binLocation": "string",
"comments": "string",
"deliveryType": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"EDISoftItemNumber": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"quantity": 0
}
],
"orderRoutings": [
{
"certificationRequired": false,
"cyclePrice": 0,
"cycleTime": 0,
"cycleUnit": "string",
"departmentNumber": "string",
"description": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedQuantity": 0,
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"ignoreVendorMinimum": false,
"operationCode": "string",
"overlapSteps": false,
"setupPrice": 0,
"setupTime": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"stepNumber": 0,
"timeUnit": "string",
"total": 0,
"vendorCode": "string",
"workCenter": "string",
"workCenterOrVendor": "string"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderLineItem"
},
"example": {
"actualEndDate": "2026-09-06T17:13:12.0000000+00:00",
"actualStartDate": "2026-09-06T17:13:12.0000000+00:00",
"billingRate": 0,
"commissionPercent": 0,
"cumulativeBilling": 0,
"currentWorkCenter": "string",
"dateFinished": "2026-09-06T17:13:12.0000000+00:00",
"discountPercent": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"FOB": "string",
"isJobLabelPrinted": false,
"isScheduled": false,
"isTaxable": false,
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"jobOnHold": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"masterJobNumber": "string",
"masterStepNumber": 0,
"miscCharges": 0,
"miscChargesBilled": false,
"miscChargesForeign": 0,
"miscDescription": "string",
"orderNumber": "string",
"overlapSteps": false,
"partDescription": "string",
"partNumber": "string",
"pricingUnit": "string",
"priority": 0,
"productCode": "string",
"quantityCanceled": 0,
"quantityOrdered": 0,
"quantityShippedToCustomer": 0,
"quantityShippedToStock": 0,
"quantityToMake": 0,
"quantityToStock": 0,
"quoteItemNumber": 0,
"quoteNumber": "string",
"revision": "string",
"scheduleLocked": false,
"status": "string",
"tempPriority": 0,
"totalActualHours": 0,
"totalEstimatedHours": 0,
"travelerPrinted": false,
"uniqueID": 0,
"unitPrice": 0,
"unitPriceForeign": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}": {
"get": {
"tags": [
"Order Line Items"
],
"summary": "Gets an Order Line Item by Order's order number and Order Line Item's item number ",
"description": "By default an order line item response will include only the fields: actualEndDate, actualStartDate, dateFinished, dueDate, estimatedEndDate, estimatedStartDate, itemNumber, jobNotes, jobNumber, masterJobNumber, orderNumber, partDescription, partNumber, pricingUnit, productCode, quantityCanceled, quantityOrdered, quantityShippedToCustomer, quantityShippedToStock, quantityToMake, quantityToStock, revision, status, totalActualHours, totalEstimatedHours, uniqueID, unitPrice, unitPriceForeign, workCode. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderLineItemSuccessResponse"
},
"example": {
"Data": {
"actualEndDate": "2026-09-06T17:13:12.0000000+00:00",
"actualStartDate": "2026-09-06T17:13:12.0000000+00:00",
"billingRate": 0,
"commissionPercent": 0,
"cumulativeBilling": 0,
"currentWorkCenter": "string",
"dateFinished": "2026-09-06T17:13:12.0000000+00:00",
"discountPercent": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"FOB": "string",
"isJobLabelPrinted": false,
"isScheduled": false,
"isTaxable": false,
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"jobOnHold": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"masterJobNumber": "string",
"masterStepNumber": 0,
"miscCharges": 0,
"miscChargesBilled": false,
"miscChargesForeign": 0,
"miscDescription": "string",
"orderNumber": "string",
"overlapSteps": false,
"partDescription": "string",
"partNumber": "string",
"pricingUnit": "string",
"priority": 0,
"productCode": "string",
"quantityCanceled": 0,
"quantityOrdered": 0,
"quantityShippedToCustomer": 0,
"quantityShippedToStock": 0,
"quantityToMake": 0,
"quantityToStock": 0,
"quoteItemNumber": 0,
"quoteNumber": "string",
"revision": "string",
"scheduleLocked": false,
"status": "string",
"tempPriority": 0,
"totalActualHours": 0,
"totalEstimatedHours": 0,
"travelerPrinted": false,
"uniqueID": 0,
"unitPrice": 0,
"unitPriceForeign": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
}
}
}
}
}
},
"patch": {
"tags": [
"Order Line Items"
],
"summary": "Updates an Order Line Item",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderLineItemUpdate"
},
"example": {
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"orderRoutings": [
{
"stepNumber": 0,
"operationCode": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.7988858+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.7988859+00:00",
"workCenter": "string"
}
]
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/order-routings": {
"get": {
"tags": [
"Order Routings"
],
"summary": "Gets a list of Order Routings",
"description": "By default an order routing response will include only the fields: actualEndDate, actualPiecesGood, actualPiecesScrap, actualStartDate, burdenRate, departmentNumber, description, employeeCode, estimatedEndDate, estimatedQuantity, estimatedStartDate, itemNumber, jobNumber, laborRate, lastModDate, leadTime, machinesRun, numberMachinesForJob, operationCode, orderNumber, partNumber, shift2DefaultEmployeeCode, shift3DefaultEmployeeCode, status, stepNumber, timeUnit, total, totalActualHours, totalEstimatedHours, totalHoursLeft, uniqueID, vendorCode, workCenter, workCenterOrVendor. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Order": {
"value": {
"orderNumber": "7025"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRoutingListSuccessResponse"
},
"example": {
"Data": [
{
"actualEndDate": "2026-09-06T17:13:12.0000000+00:00",
"actualPiecesGood": 0,
"actualPiecesScrap": 0,
"actualStartDate": "2026-09-06T17:13:12.0000000+00:00",
"burdenRate": 0,
"certificationRequired": false,
"cost1": 0,
"cost2": 0,
"cost3": 0,
"cost4": 0,
"cost5": 0,
"cost6": 0,
"cost7": 0,
"cost8": 0,
"cyclePrice": 0,
"cycleRate": 0,
"cycleTime": 0,
"cycleUnit": "string",
"departmentNumber": "string",
"description": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedQuantity": 0,
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"ignoreVendorMinimum": false,
"itemNumber": 0,
"jobClosedDate": "2026-09-06T17:13:12.0000000+00:00",
"jobStatus": "string",
"jobNumber": "string",
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"machinesRun": 0,
"markupPercent": 0,
"numberMachinesForJob": 0,
"operationCode": "string",
"orderNumber": "string",
"overlapSteps": false,
"partNumber": "string",
"percentEfficient": 0,
"scrapPercent": 0,
"setup1": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setupPrice": 0,
"setupRate": 0,
"setupTime": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"status": "string",
"stepNumber": 0,
"teamSize": 0,
"tempEstimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"tempEstimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"timeUnit": "string",
"total": 0,
"totalActualHours": 0,
"totalEstimatedHours": 0,
"totalHoursLeft": 0,
"unattendedOperation": false,
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"vendorCode": "string",
"workCenter": "string",
"workCenterOrVendor": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/order-routings": {
"post": {
"tags": [
"Order Routings"
],
"summary": "Creates an Order Routing",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRoutingCreate"
},
"example": {
"certificationRequired": false,
"cyclePrice": 0,
"cycleTime": 0,
"cycleUnit": "string",
"departmentNumber": "string",
"description": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedQuantity": 0,
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"ignoreVendorMinimum": false,
"operationCode": "string",
"overlapSteps": false,
"setupPrice": 0,
"setupTime": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"stepNumber": 0,
"timeUnit": "string",
"total": 0,
"vendorCode": "string",
"workCenter": "string",
"workCenterOrVendor": "string"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRouting"
},
"example": {
"actualEndDate": "2026-09-06T17:13:12.0000000+00:00",
"actualPiecesGood": 0,
"actualPiecesScrap": 0,
"actualStartDate": "2026-09-06T17:13:12.0000000+00:00",
"burdenRate": 0,
"certificationRequired": false,
"cost1": 0,
"cost2": 0,
"cost3": 0,
"cost4": 0,
"cost5": 0,
"cost6": 0,
"cost7": 0,
"cost8": 0,
"cyclePrice": 0,
"cycleRate": 0,
"cycleTime": 0,
"cycleUnit": "string",
"departmentNumber": "string",
"description": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedQuantity": 0,
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"ignoreVendorMinimum": false,
"itemNumber": 0,
"jobClosedDate": "2026-09-06T17:13:12.0000000+00:00",
"jobStatus": "string",
"jobNumber": "string",
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"machinesRun": 0,
"markupPercent": 0,
"numberMachinesForJob": 0,
"operationCode": "string",
"orderNumber": "string",
"overlapSteps": false,
"partNumber": "string",
"percentEfficient": 0,
"scrapPercent": 0,
"setup1": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setupPrice": 0,
"setupRate": 0,
"setupTime": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"status": "string",
"stepNumber": 0,
"teamSize": 0,
"tempEstimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"tempEstimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"timeUnit": "string",
"total": 0,
"totalActualHours": 0,
"totalEstimatedHours": 0,
"totalHoursLeft": 0,
"unattendedOperation": false,
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"vendorCode": "string",
"workCenter": "string",
"workCenterOrVendor": "string"
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/order-routings/{stepNumber}": {
"get": {
"tags": [
"Order Routings"
],
"summary": "Gets an order routing by order number and order routing's item number and order routing's step number",
"description": "By default an order routing response will include only the fields: actualEndDate, actualPiecesGood, actualPiecesScrap, actualStartDate, burdenRate, departmentNumber, description, employeeCode, estimatedEndDate, estimatedQuantity, estimatedStartDate, itemNumber, jobNumber, laborRate, lastModDate, leadTime, machinesRun, numberMachinesForJob, operationCode, orderNumber, partNumber, shift2DefaultEmployeeCode, shift3DefaultEmployeeCode, status, stepNumber, timeUnit, total, totalActualHours, totalEstimatedHours, totalHoursLeft, uniqueID, vendorCode, workCenter, workCenterOrVendor. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "stepNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRoutingSuccessResponse"
},
"example": {
"Data": {
"actualEndDate": "2026-09-06T17:13:12.0000000+00:00",
"actualPiecesGood": 0,
"actualPiecesScrap": 0,
"actualStartDate": "2026-09-06T17:13:12.0000000+00:00",
"burdenRate": 0,
"certificationRequired": false,
"cost1": 0,
"cost2": 0,
"cost3": 0,
"cost4": 0,
"cost5": 0,
"cost6": 0,
"cost7": 0,
"cost8": 0,
"cyclePrice": 0,
"cycleRate": 0,
"cycleTime": 0,
"cycleUnit": "string",
"departmentNumber": "string",
"description": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedQuantity": 0,
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"GLCode": "string",
"ignoreVendorMinimum": false,
"itemNumber": 0,
"jobClosedDate": "2026-09-06T17:13:12.0000000+00:00",
"jobStatus": "string",
"jobNumber": "string",
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"machinesRun": 0,
"markupPercent": 0,
"numberMachinesForJob": 0,
"operationCode": "string",
"orderNumber": "string",
"overlapSteps": false,
"partNumber": "string",
"percentEfficient": 0,
"scrapPercent": 0,
"setup1": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setupPrice": 0,
"setupRate": 0,
"setupTime": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"status": "string",
"stepNumber": 0,
"teamSize": 0,
"tempEstimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"tempEstimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"timeUnit": "string",
"total": 0,
"totalActualHours": 0,
"totalEstimatedHours": 0,
"totalHoursLeft": 0,
"unattendedOperation": false,
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"vendorCode": "string",
"workCenter": "string",
"workCenterOrVendor": "string"
}
}
}
}
}
}
},
"patch": {
"tags": [
"Order Routings"
],
"summary": "Updates an Order Routing",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "stepNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRoutingUpdate"
},
"example": {
"operationCode": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.8259325+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.8259334+00:00",
"workCenter": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/orders": {
"get": {
"tags": [
"Orders"
],
"summary": "Gets a list of Orders",
"description": "By default an order response will include only the fields: customerCode, customerDescription, dateEntered, lastModDate, orderNumber, orderTotal, orderTotalForeign, PONumber, salesID, status, termsCode, territory, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Customer": {
"value": {
"customerCode": "ALPHA"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderListSuccessResponse"
},
"example": {
"Data": [
{
"ackPrinted": false,
"addCustomerFromQuote": false,
"allowExpiredQuoteItems": false,
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerDescription": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"dateEnteredLabel": "2026-09-06T17:13:12.0000000+00:00",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"fax": "string",
"GSTCode": "string",
"holdUntilAccountIsCurrent": false,
"JTPrinted": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"mainDueDate": "2026-09-06T17:13:12.0000000+00:00",
"mainPriority": 0,
"markCustomerActive": false,
"notesToCustomer": "string",
"orderNumber": "string",
"orderTotal": 0,
"orderTotalForeign": 0,
"phone": "string",
"PONumber": "string",
"purchasingContact": "string",
"quoteNumber": "string",
"salesID": "string",
"saveOnDuplicateCustomerPONumber": false,
"shippingAddress1": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingState": "string",
"shipToName": "string",
"shipVia": "string",
"shipZIP": "string",
"status": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"WOPrinted": false
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Orders"
],
"summary": "Creates an Order",
"description": "Note: If auto-numbering for orders is not enabled in company maintenance settings, you must specify an order number in your request. If auto-numbering is enabled, you may leave this field off the request and an order number will be assigned automatically.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderCreate"
},
"example": {
"addCustomerFromQuote": false,
"allowExpiredQuoteItems": false,
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerDescription": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"exchangeRate": 0,
"fax": "string",
"GSTCode": "string",
"holdUntilAccountIsCurrent": false,
"location": "string",
"mainDueDate": "2026-09-06T17:13:12.0000000+00:00",
"mainPriority": 0,
"markCustomerActive": false,
"notesToCustomer": "string",
"orderNumber": "string",
"phone": "string",
"PONumber": "string",
"purchasingContact": "string",
"quoteNumber": "string",
"salesID": "string",
"saveOnDuplicateCustomerPONumber": false,
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingState": "string",
"shipToName": "string",
"shipVia": "string",
"shipZIP": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"orderLineItems": [
{
"billingRate": 0,
"commissionPercent": 0,
"discountPercent": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"FOB": "string",
"isTaxable": false,
"jobNotes": "string",
"miscCharges": 0,
"miscDescription": "string",
"partDescription": "string",
"partNumber": "string",
"pricingUnit": "string",
"priority": 0,
"productCode": "string",
"quantityOrdered": 0,
"quoteItemNumber": 0,
"quoteNumber": "string",
"revision": "string",
"totalEstimatedHours": 0,
"unitPrice": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string",
"releases": [
{
"binLocation": "string",
"comments": "string",
"deliveryType": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"EDISoftItemNumber": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"quantity": 0
}
],
"orderRoutings": [
{
"certificationRequired": false,
"cyclePrice": 0,
"cycleTime": 0,
"cycleUnit": "string",
"departmentNumber": "string",
"description": "string",
"employeeCode": "string",
"estimatedEndDate": "2026-09-06T17:13:12.0000000+00:00",
"estimatedQuantity": 0,
"estimatedStartDate": "2026-09-06T17:13:12.0000000+00:00",
"ignoreVendorMinimum": false,
"operationCode": "string",
"overlapSteps": false,
"setupPrice": 0,
"setupTime": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"stepNumber": 0,
"timeUnit": "string",
"total": 0,
"vendorCode": "string",
"workCenter": "string",
"workCenterOrVendor": "string"
}
]
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
},
"example": {
"ackPrinted": false,
"addCustomerFromQuote": false,
"allowExpiredQuoteItems": false,
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerDescription": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"dateEnteredLabel": "2026-09-06T17:13:12.0000000+00:00",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"fax": "string",
"GSTCode": "string",
"holdUntilAccountIsCurrent": false,
"JTPrinted": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"mainDueDate": "2026-09-06T17:13:12.0000000+00:00",
"mainPriority": 0,
"markCustomerActive": false,
"notesToCustomer": "string",
"orderNumber": "string",
"orderTotal": 0,
"orderTotalForeign": 0,
"phone": "string",
"PONumber": "string",
"purchasingContact": "string",
"quoteNumber": "string",
"salesID": "string",
"saveOnDuplicateCustomerPONumber": false,
"shippingAddress1": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingState": "string",
"shipToName": "string",
"shipVia": "string",
"shipZIP": "string",
"status": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"WOPrinted": false
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}": {
"get": {
"tags": [
"Orders"
],
"summary": "Gets an Order by order number",
"description": "By default an order response will include only the fields: customerCode, customerDescription, dateEntered, lastModDate, orderNumber, orderTotal, orderTotalForeign, PONumber, salesID, status, termsCode, territory, uniqueID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSuccessResponse"
},
"example": {
"Data": {
"ackPrinted": false,
"addCustomerFromQuote": false,
"allowExpiredQuoteItems": false,
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerDescription": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"dateEnteredLabel": "2026-09-06T17:13:12.0000000+00:00",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"fax": "string",
"GSTCode": "string",
"holdUntilAccountIsCurrent": false,
"JTPrinted": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"mainDueDate": "2026-09-06T17:13:12.0000000+00:00",
"mainPriority": 0,
"markCustomerActive": false,
"notesToCustomer": "string",
"orderNumber": "string",
"orderTotal": 0,
"orderTotalForeign": 0,
"phone": "string",
"PONumber": "string",
"purchasingContact": "string",
"quoteNumber": "string",
"salesID": "string",
"saveOnDuplicateCustomerPONumber": false,
"shippingAddress1": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingState": "string",
"shipToName": "string",
"shipVia": "string",
"shipZIP": "string",
"status": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"WOPrinted": false
}
}
}
}
}
}
},
"patch": {
"tags": [
"Orders"
],
"summary": "Updates an Order",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderUpdate"
},
"example": {
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/packing-list-line-items": {
"get": {
"tags": [
"Packing List Line Items"
],
"summary": "Gets a list of Packing List Line Items",
"description": "By default a packing list line item response will include only the fields: accountingID, contactName, containerNumber, customerPONumber, deliveryTicketItemNumber, deliveryTicketNumber, isTaxable, jobNumber, lastModDate, lastModUser, masterJobNumber, partDescription, partNumber, partWeight, quantityFromStock, quantityOpen, quantityToCancel, quantityToShip, quantityToStock, revision, uniqueID, unit. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Packing List": {
"value": {
"deliveryTicketNumber": "4692"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackingListLineItemListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"contactName": "string",
"containerNumber": "string",
"customerPONumber": "string",
"deliveryTicketItemNumber": 0,
"deliveryTicketNumber": "string",
"isTaxable": false,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"masterJobNumber": "string",
"partDescription": "string",
"partNumber": "string",
"partWeight": 0,
"quantityFromStock": 0,
"quantityOpen": 0,
"quantityToCancel": 0,
"quantityToShip": 0,
"quantityToStock": 0,
"revision": "string",
"uniqueID": 0,
"unit": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/packing-lists": {
"get": {
"tags": [
"Packing Lists"
],
"summary": "Gets a list of Packing Lists",
"description": "By default a packing list response will include only the fields: active, address1, city, commissionAccount, commissionPercent, country, lastModDate, lastModUser, name, phone, salesID, state, uniqueID, YTDCommission, YTDSales, zipCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Customer": {
"value": {
"customerCode": "BASS"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackingListListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"autoBill": false,
"certificatePrinted": false,
"CODAmount": 0,
"CODAmountPrepaid": false,
"CODFee": 0,
"CODFeePrepaid": false,
"containerOption": 0,
"containerUnit": "string",
"containerWeight": 0,
"country": "string",
"customerCode": "string",
"customerDescription": "string",
"customerPONumber": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketNumber": "string",
"descriptionOfContents": "string",
"enteredBy": "string",
"exported": false,
"exportedToEDI": false,
"freightCharge": 0,
"freightChargePrepaid": false,
"freightTerms": "string",
"freightVendorCode": "string",
"handlingCharge": 0,
"isProcessed": 0,
"isShipmentFromSystem": false,
"labelPrinted": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"notesToCustomer": "string",
"numberOfContainers": 0,
"orderNumber": "string",
"packingListPrinted": false,
"remitAddress1": "string",
"remitCity": "string",
"remitCountry": "string",
"remitName": "string",
"remitStreet": "string",
"remitZIP": "string",
"shippingAddress1": "string",
"shippingCharges": 0,
"shippingCity": "string",
"shippingCode": "string",
"shippingDate": "2026-09-06T17:13:12.0000000+00:00",
"shippingStreet": "string",
"shippingToName": "string",
"shippingVia": "string",
"shippingZIP": "string",
"specialInstructions": "string",
"status": "string",
"uniqueID": 0,
"vendorDescription": "string",
"weightOfParts": 0
}
]
}
}
}
}
}
}
},
"/api/v1/product-codes": {
"get": {
"tags": [
"Product Codes"
],
"summary": "Gets a list of Product Codes",
"description": "By default a product code response will include only the fields: active, ARAccount, cashDiscount, description, freightAccount, lastModDate, lastModUser, productCode, uniqueID, salesAccount. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by AR Account": {
"value": {
"ARAccount": "1240"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductCodeListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"ARAccount": "string",
"cashDiscount": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"freightAccount": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"productCode": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"salesAccount": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/product-codes/{productCode}": {
"get": {
"tags": [
"Product Codes"
],
"summary": "Gets a Product Code by specifying the productCode",
"description": "By default a product code response will include only the fields: active, ARAccount, cashDiscount, description, freightAccount, lastModDate, lastModUser, productCode, uniqueID, salesAccount. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "productCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductCodeSuccessResponse"
},
"example": {
"Data": {
"active": false,
"ARAccount": "string",
"cashDiscount": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"freightAccount": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"productCode": "string",
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"salesAccount": "string",
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/purchase-order-line-items": {
"get": {
"tags": [
"Purchase Order Line Items"
],
"summary": "Gets a list of Purchase Order Line Items",
"description": "By default a purchase order line item response will include only the fields: dateFinished, dueDate, itemNumber, lastModDate, outsideService, partDescription, partNumber, purchaseOrderNumber, quantityCanceled, quantityOrdered, quantityReceived, quantityRejected, revision, status, stepNumber, uniqueID, unit, unitCost, unitCostForeign. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Purchase Order": {
"value": {
"purchaseOrderNumber": "4969"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderLineItemListSuccessResponse"
},
"example": {
"Data": [
{
"certificationRequired": false,
"comments": "string",
"dateFinished": "2026-09-06T17:13:12.0000000+00:00",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"FOB": "string",
"GLCode": "string",
"gridDueDate": "string",
"isProcessed": false,
"itemNumber": 0,
"jobNumber": "string",
"jobNumber1": "string",
"jobNumber10": "string",
"jobNumber2": "string",
"jobNumber3": "string",
"jobNumber4": "string",
"jobNumber5": "string",
"jobNumber6": "string",
"jobNumber7": "string",
"jobNumber8": "string",
"jobNumber9": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"markupPercent": 0,
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"outsideService": false,
"partDescription": "string",
"partNumber": "string",
"productCode": "string",
"purchaseOrderNumber": "string",
"quantityCanceled": 0,
"quantityOrdered": 0,
"quantityReceived": 0,
"quantityRejected": 0,
"quantityRequired1": 0,
"quantityRequired10": 0,
"quantityRequired2": 0,
"quantityRequired3": 0,
"quantityRequired4": 0,
"quantityRequired5": 0,
"quantityRequired6": 0,
"quantityRequired7": 0,
"quantityRequired8": 0,
"quantityRequired9": 0,
"revision": "string",
"status": "string",
"stepNumber": 0,
"taxStatus": false,
"uniqueID": 0,
"unit": "string",
"unitCost": 0,
"unitCostForeign": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/purchase-order-line-items/{purchaseOrderNumber}/{partNumber}/{itemNumber}": {
"patch": {
"tags": [
"Purchase Order Line Items"
],
"summary": "Updates a Purchase Order Line Item",
"parameters": [
{
"name": "purchaseOrderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderLineItemUpdate"
},
"example": {
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/purchase-order-releases": {
"get": {
"tags": [
"Purchase Order Releases"
],
"summary": "Gets a list of Purchase Order Releases",
"description": "By default a purchase order release response will include only the fields: comments, dateReceived, dueDate, itemNumber, jobNumber, lastModDate, lastModUser, partNumber, PONumber, quantity, quantityCanceled, quantityRejected, receiverNumber, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Purchase Order": {
"value": {
"PONumber": "4971"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderReleaseListSuccessResponse"
},
"example": {
"Data": [
{
"comments": "string",
"dateReceived": "2026-09-06T17:13:12.0000000+00:00",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"itemNumber": 0,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"partNumber": "string",
"PONumber": "string",
"quantity": 0,
"quantityCanceled": 0,
"quantityRejected": 0,
"receiverNumber": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/purchase-orders": {
"get": {
"tags": [
"Purchase Orders"
],
"summary": "Gets a list of Purchase Orders",
"description": "By default a purchase order response will include only the fields: contact, currencyCode, dateEntered, lastModDate, phone, PONumber, purchasedBy, shipCode, status, uniqueID, vendorCode, vendorDescription, vendorQuoteNumber, vendorType. You may specify the exact fields to return using the fields parameter. When filtering by status, use O for open purchase orders and C for closed 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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section. For status filters, use O (open) or C (closed).",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Vendor": {
"value": {
"vendorCode": "RYERSON"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderListSuccessResponse"
},
"example": {
"Data": [
{
"contact": "string",
"currencyCode": "string",
"dateComplete": "2026-09-06T17:13:12.0000000+00:00",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"dateEnteredLabel": "2026-09-06T17:13:12.0000000+00:00",
"dateRequired": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketPrinted": false,
"enteredBy": "string",
"exchangeRate": 0,
"fax": "string",
"GSTCharges": 0,
"GSTCode": "string",
"GSTCodeForeign": 0,
"ignoreMinimumOrder": false,
"labelPrinted": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"mainDueDate": "2026-09-06T17:13:12.0000000+00:00",
"notesToVendor": "string",
"phone": "string",
"PONumber": "string",
"POPrinted": false,
"POTotal": 0,
"POTotalForeign": 0,
"processFlag": 0,
"purchasedBy": "string",
"RFQNumber": "string",
"salesTaxCharges": 0,
"salesTaxChargesForeign": 0,
"salesTaxCode": "string",
"shipCode": "string",
"shippingAddress1": "string",
"shippingAddressType": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingStreet": "string",
"shippingZip": "string",
"shipToName": "string",
"shipVia": "string",
"status": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorCode": "string",
"vendorDescription": "string",
"vendorQuoteNumber": "string",
"vendorType": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/purchase-orders/{PONumber}": {
"get": {
"tags": [
"Purchase Orders"
],
"summary": "Gets a Purchase Order by PO number",
"description": "By default a purchase order response will include only the fields: contact, currencyCode, dateEntered, lastModDate, phone, PONumber, purchasedBy, shipCode, status, uniqueID, vendorCode, vendorDescription, vendorQuoteNumber, vendorType. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "PONumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderSuccessResponse"
},
"example": {
"Data": {
"contact": "string",
"currencyCode": "string",
"dateComplete": "2026-09-06T17:13:12.0000000+00:00",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"dateEnteredLabel": "2026-09-06T17:13:12.0000000+00:00",
"dateRequired": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketPrinted": false,
"enteredBy": "string",
"exchangeRate": 0,
"fax": "string",
"GSTCharges": 0,
"GSTCode": "string",
"GSTCodeForeign": 0,
"ignoreMinimumOrder": false,
"labelPrinted": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"mainDueDate": "2026-09-06T17:13:12.0000000+00:00",
"notesToVendor": "string",
"phone": "string",
"PONumber": "string",
"POPrinted": false,
"POTotal": 0,
"POTotalForeign": 0,
"processFlag": 0,
"purchasedBy": "string",
"RFQNumber": "string",
"salesTaxCharges": 0,
"salesTaxChargesForeign": 0,
"salesTaxCode": "string",
"shipCode": "string",
"shippingAddress1": "string",
"shippingAddressType": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingStreet": "string",
"shippingZip": "string",
"shipToName": "string",
"shipVia": "string",
"status": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorCode": "string",
"vendorDescription": "string",
"vendorQuoteNumber": "string",
"vendorType": "string"
}
}
}
}
}
}
},
"patch": {
"tags": [
"Purchase Orders"
],
"summary": "Updates a Purchase Order",
"parameters": [
{
"name": "PONumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderUpdate"
},
"example": {
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/quote-line-items": {
"get": {
"tags": [
"Quote Line Items"
],
"summary": "Gets a list of Quote Line Items",
"description": "By default a quote line item response will include only the fields: commissionPercent, delivery, description, discountPercent, FOB, isTaxable, itemNumber, jobNotes, jobNumber, lastModDate, lastModUser, miscCharge, miscChargeForeign, miscDescription, partNumber, price1, price2, price3, price4, price5, price6, price7, price8, priceForeign1, priceForeign2, priceForeign3, priceForeign4, priceForeign5, priceForeign6, priceForeign7, priceForeign8, quantity1, quantity2, quantity3, quantity4, quantity5, quantity6, quantity7, quantity8, quoteNumber, quotePart, revision, status, uniqueID, unit1, unit2, unit3, unit4, unit5, unit6, unit7, unit8, workCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by SalesID": {
"value": {
"quoteNumber": "1814"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteLineItemListSuccessResponse"
},
"example": {
"Data": [
{
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"isTaxable": false,
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"quoteNumber": "string",
"quotePart": false,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteNumber}/quote-line-item/{itemNumber}": {
"get": {
"tags": [
"Quote Line Items"
],
"summary": "Gets a Quote Line Item",
"description": "By default a quote line item response will include only the fields: commissionPercent, delivery, description, discountPercent, FOB, isTaxable, itemNumber, jobNotes, jobNumber, lastModDate, lastModUser, miscCharge, miscChargeForeign, miscDescription, partNumber, price1, price2, price3, price4, price5, price6, price7, price8, priceForeign1, priceForeign2, priceForeign3, priceForeign4, priceForeign5, priceForeign6, priceForeign7, priceForeign8, quantity1, quantity2, quantity3, quantity4, quantity5, quantity6, quantity7, quantity8, quoteNumber, quotePart, revision, status, uniqueID, unit1, unit2, unit3, unit4, unit5, unit6, unit7, unit8, workCode. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "quoteNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteLineItemSuccessResponse"
},
"example": {
"Data": {
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"isTaxable": false,
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"quoteNumber": "string",
"quotePart": false,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteNumber}/quote-line-items": {
"post": {
"tags": [
"Quote Line Items"
],
"summary": "Creates a Quote Line Item",
"description": "Please see the currency fields documentation for information about the `price#`/`price#Foreign` and `miscCharge`/`miscChargeForeign` fields.",
"parameters": [
{
"name": "quoteNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteLineItemCreate"
},
"example": {
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteLineItem"
},
"example": {
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"isTaxable": false,
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"quoteNumber": "string",
"quotePart": false,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteNumber}/quote-line-items/{itemNumber}": {
"patch": {
"tags": [
"Quote Line Items"
],
"summary": "Updates a Quote Line Item",
"description": "Please see the currency fields documentation for information about the `price#`/`price#Foreign` and `miscCharge`/`miscChargeForeign` fields.",
"parameters": [
{
"name": "quoteNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteLineItemUpdate"
},
"example": {
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/quotes": {
"get": {
"tags": [
"Quotes"
],
"summary": "Gets a list of Quotes",
"description": "By default a quote response will include only the fields: quoteNumber, customerCode, customerName, address1, phone, dateEntered, quotedBy, contactName, salesID, followUpDate, expireDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Quote": {
"value": {
"customerCode": "ALPHA"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteListSuccessResponse"
},
"example": {
"Data": [
{
"address1": "string",
"city": "string",
"contactName": "string",
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerName": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"expireDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"followUpDate": "2026-09-06T17:13:12.0000000+00:00",
"GSTCode": "string",
"inquiryNumber": "string",
"isFreeFormCustomer": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"notes": "string",
"phone": "string",
"printed": false,
"quotedBy": "string",
"quoteNumber": "string",
"salesID": "string",
"shippingCode": "string",
"shipToName": "string",
"shipVia": "string",
"state": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"zipCode": "string"
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Quotes"
],
"summary": "Creates a Quote",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteCreate"
},
"example": {
"lineItems": [
{
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
],
"address1": "string",
"city": "string",
"contactName": "string",
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerName": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"exchangeRate": 0,
"expireDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"followUpDate": "2026-09-06T17:13:12.0000000+00:00",
"GSTCode": "string",
"inquiryNumber": "string",
"isFreeFormCustomer": false,
"location": "string",
"notes": "string",
"phone": "string",
"quotedBy": "string",
"quoteNumber": "string",
"salesID": "string",
"shippingCode": "string",
"shipToName": "string",
"shipVia": "string",
"state": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"zipCode": "string"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Quote"
},
"example": {
"address1": "string",
"city": "string",
"contactName": "string",
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerName": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"expireDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"followUpDate": "2026-09-06T17:13:12.0000000+00:00",
"GSTCode": "string",
"inquiryNumber": "string",
"isFreeFormCustomer": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"notes": "string",
"phone": "string",
"printed": false,
"quotedBy": "string",
"quoteNumber": "string",
"salesID": "string",
"shippingCode": "string",
"shipToName": "string",
"shipVia": "string",
"state": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"zipCode": "string"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteNumber}": {
"get": {
"tags": [
"Quotes"
],
"summary": "Gets a Quote by order number",
"description": "By default a quote response will include only the fields: quoteNumber, customerCode, customerName, address1, phone, dateEntered, quotedBy, contactName, salesID, followUpDate, expireDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "quoteNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSuccessResponse"
},
"example": {
"Data": {
"address1": "string",
"city": "string",
"contactName": "string",
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerName": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"enteredBy": "string",
"exchangeRate": 0,
"expireDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"followUpDate": "2026-09-06T17:13:12.0000000+00:00",
"GSTCode": "string",
"inquiryNumber": "string",
"isFreeFormCustomer": false,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"location": "string",
"notes": "string",
"phone": "string",
"printed": false,
"quotedBy": "string",
"quoteNumber": "string",
"salesID": "string",
"shippingCode": "string",
"shipToName": "string",
"shipVia": "string",
"state": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"zipCode": "string"
}
}
}
}
}
}
},
"patch": {
"tags": [
"Quotes"
],
"summary": "Updates a Quote",
"parameters": [
{
"name": "quoteNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteUpdate"
},
"example": {
"lineItems": [
{
"commissionPercent": 0,
"delivery": "string",
"description": "string",
"discountPercent": 0,
"FOB": "string",
"itemNumber": 0,
"jobNotes": "string",
"jobNumber": "string",
"miscCharge": 0,
"miscChargeForeign": 0,
"miscDescription": "string",
"partNumber": "string",
"price1": 0,
"price2": 0,
"price3": 0,
"price4": 0,
"price5": 0,
"price6": 0,
"price7": 0,
"price8": 0,
"priceForeign1": 0,
"priceForeign2": 0,
"priceForeign3": 0,
"priceForeign4": 0,
"priceForeign5": 0,
"priceForeign6": 0,
"priceForeign7": 0,
"priceForeign8": 0,
"quantity1": 0,
"quantity2": 0,
"quantity3": 0,
"quantity4": 0,
"quantity5": 0,
"quantity6": 0,
"quantity7": 0,
"quantity8": 0,
"revision": "string",
"status": "string",
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCode": "string"
}
],
"address1": "string",
"city": "string",
"contactName": "string",
"country": "string",
"currencyCode": "string",
"customerCode": "string",
"customerName": "string",
"dateEntered": "2026-09-06T17:13:12.0000000+00:00",
"exchangeRate": 0,
"expireDate": "2026-09-06T17:13:12.0000000+00:00",
"fax": "string",
"followUpDate": "2026-09-06T17:13:12.0000000+00:00",
"GSTCode": "string",
"inquiryNumber": "string",
"isFreeFormCustomer": false,
"location": "string",
"notes": "string",
"phone": "string",
"quotedBy": "string",
"salesID": "string",
"shippingCode": "string",
"shipToName": "string",
"shipVia": "string",
"state": "string",
"taxCode": "string",
"termsCode": "string",
"territory": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:12.0000000+00:00",
"user_Date2": "2026-09-06T17:13:12.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"zipCode": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/reason-codes": {
"get": {
"tags": [
"Reason Codes"
],
"summary": "Gets a list of Reason Codes",
"description": "By default a reason code response will include only the fields: active, createRMA, description, lastModDate, lastModUser, reasonCode, reasonCodeID, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Active Reason Code": {
"value": {
"active": "true"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReasonCodeListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"createRMA": false,
"description": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"reasonCode": "string",
"reasonCodeID": 0,
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/reason-codes/{uniqueID}": {
"get": {
"tags": [
"Reason Codes"
],
"summary": "Gets an reason code by uniqueID",
"description": "By default a reason code response will include only the fields: active, createRMA, description, lastModDate, lastModUser, reasonCode, reasonCodeID, uniqueID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "uniqueID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReasonCodeSuccessResponse"
},
"example": {
"Data": {
"active": false,
"createRMA": false,
"description": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"reasonCode": "string",
"reasonCodeID": 0,
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/releases": {
"post": {
"tags": [
"Releases"
],
"summary": "Creates a Order Release",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseCreate"
},
"example": {
"binLocation": "string",
"comments": "string",
"deliveryType": 0,
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"EDISoftItemNumber": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"quantity": 0
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Release"
},
"example": {
"binLocation": "string",
"comments": "string",
"dateComplete": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketNumber": "string",
"deliveryType": 0,
"destinationJobNumber": "string",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"EDISoftItemNumber": 0,
"itemNumber": 0,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"manufacturingJobNumber": "string",
"orderNumber": "string",
"partDescription": "string",
"partNumber": "string",
"quantity": 0,
"uniqueID": 0
}
}
}
}
}
}
},
"/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/releases/{uniqueID}": {
"get": {
"tags": [
"Releases"
],
"summary": "Gets an Order Release from an order by Order Number, Item Number and Unique ID",
"description": "By default a release response will include only the fields: binLocation, comments, dateComplete, deliveryTicketNumber, deliveryType, destinationJobNumber, dueDate, itemNumber, jobNumber, lastModDate, lotNumber, manufacturingJobNumber, orderNumber, partDescription, partNumber, quantity, uniqueID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "orderNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "uniqueID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseSuccessResponse"
},
"example": {
"Data": {
"binLocation": "string",
"comments": "string",
"dateComplete": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketNumber": "string",
"deliveryType": 0,
"destinationJobNumber": "string",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"EDISoftItemNumber": 0,
"itemNumber": 0,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"manufacturingJobNumber": "string",
"orderNumber": "string",
"partDescription": "string",
"partNumber": "string",
"quantity": 0,
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/releases": {
"get": {
"tags": [
"Releases"
],
"summary": "Gets a list of Releases",
"description": "By default a release response will include only the fields: binLocation, comments, dateComplete, deliveryTicketNumber, deliveryType, destinationJobNumber, dueDate, itemNumber, jobNumber, lastModDate, lotNumber, manufacturingJobNumber, orderNumber, partDescription, partNumber, quantity, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Order": {
"value": {
"orderNumber": "7025"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseListSuccessResponse"
},
"example": {
"Data": [
{
"binLocation": "string",
"comments": "string",
"dateComplete": "2026-09-06T17:13:12.0000000+00:00",
"deliveryTicketNumber": "string",
"deliveryType": 0,
"destinationJobNumber": "string",
"dueDate": "2026-09-06T17:13:12.0000000+00:00",
"EDISoftItemNumber": 0,
"itemNumber": 0,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"lotNumber": "string",
"manufacturingJobNumber": "string",
"orderNumber": "string",
"partDescription": "string",
"partNumber": "string",
"quantity": 0,
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/reports": {
"post": {
"tags": [
"Reports"
],
"requestBody": {
"content": {
"application/json": {
"schema": { }
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/reports/{requestId}": {
"get": {
"tags": [
"Reports"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/estimates/{partNumber}/routings/{stepNumber}": {
"get": {
"tags": [
"Routings"
],
"summary": "Gets a Routing by estimate's part number and routing's step number ",
"description": "By default a Routing response will include only the fields: partNumber, stepNumber, workOrVendor, workCenter, vendorCode, operatorCode, description, setupTime, timeUnit, cycleTime, cycleUnit, machineRun, teamSize, scrapPercent, laborAccount, setupRate, cycleRate, burdenRate, laborRate, isUnattendedOperation, leadTime, markupPercent, isCertificationRequired, GLAccount, cost1, unit1, setup1, setupPrice, cyclePrice, total, estimQuantity, actualPiecesGood, actualPiecesScrapped, ignoreVendorMinimum, numberMachineForJob, uniqueID, lastModDate. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "partNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "stepNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutingSuccessResponse"
},
"example": {
"Data": {
"actualPiecesGood": 0,
"actualPiecesScrapped": 0,
"burdenRate": 0,
"cost1": 0,
"cost2": 0,
"cost3": 0,
"cost4": 0,
"cost5": 0,
"cost6": 0,
"cost7": 0,
"cost8": 0,
"cyclePrice": 0,
"cycleRate": 0,
"cycleTime": 0,
"cycleUnit": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"estimQuantity": 0,
"GLAccount": "string",
"ignoreVendorMinimum": false,
"isCertificationRequired": false,
"isUnattendedOperation": false,
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"machineRun": 0,
"markupPercent": 0,
"numberMachineForJob": 0,
"operatorCode": "string",
"partNumber": "string",
"percentEfficient": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"scrapPercent": 0,
"setup1": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setupPrice": 0,
"setupRate": 0,
"setupTime": 0,
"stepNumber": 0,
"teamSize": 0,
"timeUnit": "string",
"total": 0,
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"vendorCode": "string",
"workCenter": "string",
"workOrVendor": "string"
}
}
}
}
}
}
}
},
"/api/v1/routings": {
"get": {
"tags": [
"Routings"
],
"summary": "Gets a list of Routings",
"description": "By default a routing response will include only the fields: partNumber, stepNumber, workOrVendor, workCenter, vendorCode, operatorCode, description, setupTime, timeUnit, cycleTime, cycleUnit, machineRun, teamSize, scrapPercent, laborAccount, setupRate, cycleRate, burdenRate, laborRate, isUnattendedOperation, leadTime, markupPercent, isCertificationRequired, GLAccount, cost1, unit1, setup1, setupPrice, cyclePrice, total, estimQuantity, actualPiecesGood, actualPiecesScrapped, ignoreVendorMinimum, numberMachineForJob, uniqueID, lastModDate. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Part Number": {
"value": {
"partNumber": "R-9002-007"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutingListSuccessResponse"
},
"example": {
"Data": [
{
"actualPiecesGood": 0,
"actualPiecesScrapped": 0,
"burdenRate": 0,
"cost1": 0,
"cost2": 0,
"cost3": 0,
"cost4": 0,
"cost5": 0,
"cost6": 0,
"cost7": 0,
"cost8": 0,
"cyclePrice": 0,
"cycleRate": 0,
"cycleTime": 0,
"cycleUnit": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:12.0000000+00:00",
"estimQuantity": 0,
"GLAccount": "string",
"ignoreVendorMinimum": false,
"isCertificationRequired": false,
"isUnattendedOperation": false,
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"machineRun": 0,
"markupPercent": 0,
"numberMachineForJob": 0,
"operatorCode": "string",
"partNumber": "string",
"percentEfficient": 0,
"revisedDate": "2026-09-06T17:13:12.0000000+00:00",
"scrapPercent": 0,
"setup1": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setupPrice": 0,
"setupRate": 0,
"setupTime": 0,
"stepNumber": 0,
"teamSize": 0,
"timeUnit": "string",
"total": 0,
"uniqueID": 0,
"unit1": "string",
"unit2": "string",
"unit3": "string",
"unit4": "string",
"unit5": "string",
"unit6": "string",
"unit7": "string",
"unit8": "string",
"vendorCode": "string",
"workCenter": "string",
"workOrVendor": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/salespersons": {
"get": {
"tags": [
"Salespersons"
],
"summary": "Gets a list of Salespersons",
"description": "By default a salesperson response will include only the fields: active, address1, city, commissionAccount, commissionPercent, country, lastModDate, lastModUser, name, phone, salesID, state, uniqueID, YTDCommission, YTDSales, zipCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by State": {
"value": {
"state": "OH"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SalespersonListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"address1": "string",
"city": "string",
"commissionAccount": "string",
"commissionPercent": 0,
"country": "string",
"lastModDate": "2026-09-06T17:13:12.0000000+00:00",
"lastModUser": "string",
"name": "string",
"phone": "string",
"salesID": "string",
"state": "string",
"uniqueID": 0,
"YTDCommission": 0,
"YTDSales": 0,
"zipCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/salespersons/{salesID}": {
"patch": {
"tags": [
"Salespersons"
],
"summary": "Updates a Salesperson",
"parameters": [
{
"name": "salesID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SalespersonUpdate"
},
"example": {
"active": false,
"address1": "string",
"city": "string",
"commissionAccount": "string",
"commissionPercent": 0,
"country": "string",
"name": "string",
"phone": "string",
"state": "string",
"zipCode": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/shipping-addresses": {
"get": {
"tags": [
"Shipping Addresses"
],
"summary": "Gets a list of Shipping Addresses",
"description": "By default a Shipping response will include only the fields: customerCode, FOB, LastModDate, LastModUser, location, printCertification, shippingAddress1, shippingCity, shippingCountry, shippingCode, shippingContact, shippingFAX, shippingPhone, uniqueID, shipToName, shipVia, shippingState, shippingZipCode, territory. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Customer": {
"value": {
"customerCode": "CARTER"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingAddressListSuccessResponse"
},
"example": {
"Data": [
{
"customerCode": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"FOB": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"location": "string",
"printCertification": false,
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingContact": "string",
"shippingCountry": "string",
"shippingFAX": "string",
"shippingPhone": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipToName": "string",
"shipVia": "string",
"territory": "string",
"uniqueID": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Shipping Addresses"
],
"summary": "Creates a Shipping Address",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingAddressCreate"
},
"example": {
"customerCode": "string",
"location": "string",
"printCertification": false,
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingContact": "string",
"shippingCountry": "string",
"shippingFAX": "string",
"shippingPhone": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipToName": "string",
"shipVia": "string",
"territory": "string"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingAddressSuccessResponse"
},
"example": {
"Data": {
"customerCode": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"FOB": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"location": "string",
"printCertification": false,
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingContact": "string",
"shippingCountry": "string",
"shippingFAX": "string",
"shippingPhone": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipToName": "string",
"shipVia": "string",
"territory": "string",
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/shipping-addresses/{customerCode}/{location}": {
"get": {
"tags": [
"Shipping Addresses"
],
"summary": "Gets a Shipping Address by customer code and location",
"description": "By default a Shipping response will include only the fields: customerCode, FOB, LastModDate, LastModUser, location, printCertification, shippingAddress1, shippingCity, shippingCountry, shippingCode, shippingContact, shippingFAX, shippingPhone, uniqueID, shipToName, shipVia, shippingState, shippingZipCode, territory. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "customerCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "location",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingAddressSuccessResponse"
},
"example": {
"Data": {
"customerCode": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"FOB": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"location": "string",
"printCertification": false,
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCode": "string",
"shippingContact": "string",
"shippingCountry": "string",
"shippingFAX": "string",
"shippingPhone": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipToName": "string",
"shipVia": "string",
"territory": "string",
"uniqueID": 0
}
}
}
}
}
}
},
"patch": {
"tags": [
"Shipping Addresses"
],
"summary": "Updates a Shipping Address",
"parameters": [
{
"name": "customerCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "location",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingAddressUpdate"
},
"example": {
"location": "string",
"printCertification": false,
"shippingAddress1": "string",
"shippingCity": "string",
"shippingContact": "string",
"shippingCountry": "string",
"shippingFAX": "string",
"shippingPhone": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipToName": "string",
"shipVia": "string",
"territory": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/tax-codes": {
"get": {
"tags": [
"Tax Codes"
],
"summary": "Gets a list of Tax Codes",
"description": "By default an order response will include only the fields: accountingID, active, allAreTaxable, description, lastModDate, lastModUser, taxGLCode, taxAccount1, taxAccount10, taxAccount2, taxAccount3, taxAccount4, taxAccount5, taxAccount6, taxAccount7, taxAccount8, taxAccount9, taxCode, uniqueID, taxFactor. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by GL Code": {
"value": {
"taxGLCode": "2280"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodeListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"active": false,
"allAreTaxable": false,
"description": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"taxAccount1": "string",
"taxAccount10": "string",
"taxAccount2": "string",
"taxAccount3": "string",
"taxAccount4": "string",
"taxAccount5": "string",
"taxAccount6": "string",
"taxAccount7": "string",
"taxAccount8": "string",
"taxAccount9": "string",
"taxCode": "string",
"taxFactor": 0,
"taxGLCode": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/tax-codes/{taxCode}": {
"get": {
"tags": [
"Tax Codes"
],
"summary": "Gets an Tax Code by tax code",
"description": "By default an order response will include only the fields: accountingID, active, allAreTaxable, description, lastModDate, lastModUser, taxGLCode, taxAccount1, taxAccount10, taxAccount2, taxAccount3, taxAccount4, taxAccount5, taxAccount6, taxAccount7, taxAccount8, taxAccount9, taxCode, uniqueID, taxFactor. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "taxCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodeSuccessResponse"
},
"example": {
"Data": {
"accountingID": "string",
"active": false,
"allAreTaxable": false,
"description": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"taxAccount1": "string",
"taxAccount10": "string",
"taxAccount2": "string",
"taxAccount3": "string",
"taxAccount4": "string",
"taxAccount5": "string",
"taxAccount6": "string",
"taxAccount7": "string",
"taxAccount8": "string",
"taxAccount9": "string",
"taxCode": "string",
"taxFactor": 0,
"taxGLCode": "string",
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/terms": {
"get": {
"tags": [
"Terms"
],
"summary": "Gets a list of Terms Code",
"description": "By default a term code response will include only the fields: accountingID, description, discountDays, discountPercent, lastModDate, lastModUser, latePercent, method, netDueDays, uniqueID, termsCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Due Date": {
"value": {
"netDueDays": "30"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TermListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"description": "string",
"discountDays": 0,
"discountPercent": 0,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"latePercent": 0,
"method": 0,
"netDueDays": 0,
"termsCode": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/terms/{termsCode}": {
"get": {
"tags": [
"Terms"
],
"summary": "Gets a Terms Code Order by Term Code",
"description": "By default a term code response will include only the fields: accountingID, description, discountDays, discountPercent, lastModDate, lastModUser, latePercent, method, netDueDays, uniqueID, termsCode. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "termsCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TermSuccessResponse"
},
"example": {
"Data": {
"accountingID": "string",
"description": "string",
"discountDays": 0,
"discountPercent": 0,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"latePercent": 0,
"method": 0,
"netDueDays": 0,
"termsCode": "string",
"uniqueID": 0
}
}
}
}
}
}
}
},
"/api/v1/time-ticket-details": {
"get": {
"tags": [
"Time Ticket Details"
],
"summary": "Gets a list of Time Ticket Details",
"description": "By default a time ticket detail response will include only the fields: actualPayRate, billingRate, comments, cycleTime, employeeCode, employeeName, jobNumber, machineHours, machinesRun, manHours, numberMachinesForJob, onlineID, operationNumber, payrollRate, piecesFinished, piecesScrapped, setupTime, shift, stepNumber, ticketDate, timeTicketGUID, uniqueID, workCenter. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Employee": {
"value": {
"employeeCode": "101"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketDetailListSuccessResponse"
},
"example": {
"Data": [
{
"actualPayRate": 0,
"adjustedPayRate": 0,
"allowClosedJobs": false,
"attendanceDetailID": 0,
"attendanceHeaderID": 0,
"billingRate": 0,
"burdenRate": 0,
"comments": "string",
"createdBy": "string",
"customerRMANumber": "string",
"cycleRate": 0,
"cycleTime": 0,
"deviceNumber": 0,
"employeeCode": 0,
"employeeName": "string",
"isMaterialAllocated": false,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"logoffTime": "2026-09-06T17:13:13.0000000+00:00",
"machineHours": 0,
"machinesRun": 0,
"manHours": 0,
"nextWorkCenter": "string",
"numberMachinesForJob": 0,
"onlineID": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"posted": false,
"reasonNumber": 0,
"searchDate": 0,
"setupRate": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"timeEnd": "string",
"timeStart": "string",
"timeTicketGUID": "string",
"unattendedOperation": false,
"uniqueID": 0,
"workCenter": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Time Ticket Details"
],
"summary": "Creates a Time Ticket Detail",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketDetailCreate"
},
"example": {
"allowClosedJobs": false,
"billingRate": 0,
"comments": "string",
"cycleTime": 0,
"employeeCode": 0,
"jobNumber": "string",
"machinesRun": 0,
"numberMachinesForJob": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"reasonNumber": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"timeEnd": "string",
"timeStart": "string",
"unattendedOperation": false,
"workCenter": 0
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketDetail"
},
"example": {
"actualPayRate": 0,
"adjustedPayRate": 0,
"allowClosedJobs": false,
"attendanceDetailID": 0,
"attendanceHeaderID": 0,
"billingRate": 0,
"burdenRate": 0,
"comments": "string",
"createdBy": "string",
"customerRMANumber": "string",
"cycleRate": 0,
"cycleTime": 0,
"deviceNumber": 0,
"employeeCode": 0,
"employeeName": "string",
"isMaterialAllocated": false,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"logoffTime": "2026-09-06T17:13:13.0000000+00:00",
"machineHours": 0,
"machinesRun": 0,
"manHours": 0,
"nextWorkCenter": "string",
"numberMachinesForJob": 0,
"onlineID": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"posted": false,
"reasonNumber": 0,
"searchDate": 0,
"setupRate": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"timeEnd": "string",
"timeStart": "string",
"timeTicketGUID": "string",
"unattendedOperation": false,
"uniqueID": 0,
"workCenter": 0
}
}
}
}
}
}
},
"/api/v1/time-ticket-details/{timeTicketGUID}": {
"get": {
"tags": [
"Time Ticket Details"
],
"summary": "Gets a Time Ticket Detail by timeTicketGUID",
"description": "By default a time ticket detail response will include only the fields: actualPayRate, billingRate, comments, cycleTime, employeeCode, employeeName, jobNumber, machineHours, machinesRun, manHours, numberMachinesForJob, onlineID, operationNumber, payrollRate, piecesFinished, piecesScrapped, setupTime, shift, stepNumber, ticketDate, timeTicketGUID, uniqueID, workCenter. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "timeTicketGUID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketDetailSuccessResponse"
},
"example": {
"Data": {
"actualPayRate": 0,
"adjustedPayRate": 0,
"allowClosedJobs": false,
"attendanceDetailID": 0,
"attendanceHeaderID": 0,
"billingRate": 0,
"burdenRate": 0,
"comments": "string",
"createdBy": "string",
"customerRMANumber": "string",
"cycleRate": 0,
"cycleTime": 0,
"deviceNumber": 0,
"employeeCode": 0,
"employeeName": "string",
"isMaterialAllocated": false,
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"logoffTime": "2026-09-06T17:13:13.0000000+00:00",
"machineHours": 0,
"machinesRun": 0,
"manHours": 0,
"nextWorkCenter": "string",
"numberMachinesForJob": 0,
"onlineID": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"posted": false,
"reasonNumber": 0,
"searchDate": 0,
"setupRate": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"timeEnd": "string",
"timeStart": "string",
"timeTicketGUID": "string",
"unattendedOperation": false,
"uniqueID": 0,
"workCenter": 0
}
}
}
}
}
}
},
"patch": {
"tags": [
"Time Ticket Details"
],
"summary": "Updates a Time Ticket Detail",
"parameters": [
{
"name": "timeTicketGUID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketDetailUpdate"
},
"example": {
"allowClosedJobs": false,
"billingRate": 0,
"comments": "string",
"cycleTime": 0,
"jobNumber": "string",
"machinesRun": 0,
"numberMachinesForJob": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"reasonNumber": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"timeEnd": "string",
"timeStart": "string",
"unattendedOperation": false,
"workCenter": 0
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/time-tickets": {
"get": {
"tags": [
"Time Tickets"
],
"summary": "Gets a list of Time Tickets",
"description": "By default a time ticket response will include only the fields: employeeCode, employeeName, enteredBy, enteredDate, lastModDate, lastModUser, searchDate, ticketDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Employee": {
"value": {
"employeeCode": "101"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketListSuccessResponse"
},
"example": {
"Data": [
{
"employeeCode": 0,
"employeeName": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"searchDate": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Time Tickets"
],
"summary": "Creates a Time Ticket",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketCreate"
},
"example": {
"timeTicketDetails": [
{
"billingRate": 0,
"comments": "string",
"cycleTime": 0,
"jobNumber": "string",
"machinesRun": 0,
"numberMachinesForJob": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"reasonNumber": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"timeEnd": "string",
"timeStart": "string",
"unattendedOperation": false,
"workCenter": 0
}
],
"allowClosedJobs": false,
"employeeCode": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicket"
},
"example": {
"employeeCode": 0,
"employeeName": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"searchDate": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0
}
}
}
}
}
}
},
"/api/v1/time-tickets/{ticketDate}/employees/{employeeCode}": {
"get": {
"tags": [
"Time Tickets"
],
"summary": "Gets a Time Ticket by its unique ID",
"description": "By default a time ticket response will include only the fields: employeeCode, employeeName, enteredBy, enteredDate, lastModDate, lastModUser, searchDate, ticketDate, uniqueID. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "ticketDate",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employeeCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketSuccessResponse"
},
"example": {
"Data": {
"employeeCode": 0,
"employeeName": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"searchDate": 0,
"ticketDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0
}
}
}
}
}
}
},
"patch": {
"tags": [
"Time Tickets"
],
"summary": "Updates a time ticket",
"parameters": [
{
"name": "ticketDate",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employeeCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeTicketUpdate"
},
"example": {
"timeTicketDetails": [
{
"timeTicketGUID": null,
"allowClosedJobs": false,
"billingRate": 0,
"comments": "string",
"cycleTime": 0,
"jobNumber": "string",
"machinesRun": 0,
"numberMachinesForJob": 0,
"operationNumber": 0,
"overTime": false,
"payrollRate": 0,
"piecesFinished": 0,
"piecesScrapped": 0,
"reasonNumber": 0,
"setupTime": 0,
"shift": 0,
"stepNumber": 0,
"timeEnd": "string",
"timeStart": "string",
"unattendedOperation": false,
"workCenter": 0
}
]
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/tooling-maintenance": {
"get": {
"tags": [
"Tooling Maintenance"
],
"summary": "Gets a list of Tooling Maintenance Records",
"description": "By default a tooling maintenance response will include only the fields: completed, cost, description, employeeCode, endDate, invoiceNumber, jobNumber, lastModDate, lastModUser, partDescription, partNumber, startDate, toolingCode, uniqueID, vendorCode. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Employee Code": {
"value": {
"employeeCode": "101"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolingMaintenanceListSuccessResponse"
},
"example": {
"Data": [
{
"completed": false,
"cost": 0,
"description": "string",
"employeeCode": "string",
"endDate": "2026-09-06T17:13:13.0000000+00:00",
"invoiceNumber": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"partDescription": "string",
"partNumber": "string",
"startDate": "2026-09-06T17:13:13.0000000+00:00",
"toolingCode": "string",
"uniqueID": 0,
"vendorCode": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/user-labels": {
"get": {
"tags": [
"User Labels"
],
"summary": "Gets a list of User Labels",
"description": "By default a user label response will include only the fields: area, currency1, currency2, date1, date2, lastModDate, memo1, number1, number2, number3, number4, text1, text2, text3, text4, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Area": {
"value": {
"area": "Customer"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserLabelListSuccessResponse"
},
"example": {
"Data": [
{
"area": "string",
"currency1": "string",
"currency2": "string",
"date1": "string",
"date2": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"memo1": "string",
"number1": "string",
"number2": "string",
"number3": "string",
"number4": "string",
"text1": "string",
"text1Default": "string",
"text2": "string",
"text2Default": "string",
"text3": "string",
"text3Default": "string",
"text4": "string",
"text4Default": "string",
"uniqueID": 0
}
]
}
}
}
}
}
}
},
"/api/v1/user-transactions": {
"get": {
"tags": [
"User Transactions"
],
"summary": "Gets a list of User Transaction records",
"description": "By default a user transaction response will include only the fields: action, comments, object, transactionDate, uniqueID, userID, value, value2. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by userID": {
"value": {
"userID": "JOHN"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTransactionSuccessResponse"
},
"example": {
"Data": {
"action": "string",
"comments": "string",
"object": "string",
"transactionDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0,
"userID": "string",
"value": "string",
"value2": "string"
}
}
}
}
}
}
}
},
"/api/v1/vendor-returns": {
"get": {
"tags": [
"Vendor Return"
],
"summary": "Gets a list of Vendor Return records",
"description": "By default a vendor return response will include only the fields: billUsForReturn, comment, correctiveActionCode, correctiveActionNumber, createCAR, createCreditMemo, createdVendorInvoiceNo, createNC, creditDate, creditedBy, dateEntered, debitPrinted, enteredBy, inspectedBy, inspectionDate, issueDate, issuedBy, labelPrinted, lastModDate, lastModUser, PODate, purchasedBy, QCComment, reasonForReturn, receiveDate, receivedBy, receiverNumber, receivingComment, status, vendorCode, vendorDescription, uniqueID, vendorReturnNumber, vendorRMANumber. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Vendor Code": {
"value": {
"vendorCode": "EXAMPLE"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorReturnListSuccessResponse"
},
"example": {
"Data": [
{
"billUsForReturn": "string",
"comment": "string",
"correctiveActionCode": "string",
"correctiveActionNumber": "string",
"createCAR": "string",
"createCreditMemo": "string",
"createdVendorInvoiceNo": "string",
"createNC": "string",
"creditDate": "2026-09-06T17:13:13.0000000+00:00",
"creditedBy": "string",
"dateEntered": "2026-09-06T17:13:13.0000000+00:00",
"debitPrinted": "string",
"enteredBy": "string",
"inspectedBy": "string",
"inspectionDate": "2026-09-06T17:13:13.0000000+00:00",
"issueDate": "2026-09-06T17:13:13.0000000+00:00",
"issuedBy": "string",
"labelPrinted": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"PODate": "2026-09-06T17:13:13.0000000+00:00",
"purchasedBy": "string",
"QCComment": "string",
"reasonForReturn": "string",
"receiveDate": "2026-09-06T17:13:13.0000000+00:00",
"receivedBy": "string",
"receiverNumber": "string",
"receivingComment": "string",
"status": "string",
"uniqueID": 0,
"vendorCode": "string",
"vendorDescription": "string",
"vendorReturnNumber": "string",
"vendorRMANumber": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/vendor-returns-line-items": {
"get": {
"tags": [
"Vendor Return Line Items"
],
"summary": "Gets a list of Vendor Return Line Item records",
"description": "By default a vendor return line item response will include only the fields: correctiveActionNumber, createCAR, createNC, description, jobNumber, lastModDate, lastModUser, nonConfNumber, originalQuantityReceived, partDescription, partNumber, POItemNumber, PONumber, quantityGood, quantityReturned, quantityToCancel, quantityToReject, reasonCode, receiverNumber, receiverItemNumber, restockingPercent, status, stepNumber, unit, uniqueID, vendorReturnNumber, vendorReturnItemNumber. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Part Number": {
"value": {
"partNumber": "EXAMPLE"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorReturnLineItemsListSuccessResponse"
},
"example": {
"Data": [
{
"correctiveActionNumber": "string",
"createCAR": "string",
"createNC": "string",
"description": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"nonConfNumber": "string",
"originalQuantityReceived": 0,
"partDescription": "string",
"partNumber": "string",
"POItemNumber": 0,
"PONumber": "string",
"quantityGood": 0,
"quantityReturned": 0,
"quantityToCancel": 0,
"quantityToReject": 0,
"reasonCode": "string",
"receiverItemNumber": 0,
"receiverNumber": "string",
"restockingPercent": 0,
"status": "string",
"stepNumber": 0,
"uniqueID": 0,
"unit": "string",
"vendorReturnItemNumber": 0,
"vendorReturnNumber": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/vendor-returns-releases": {
"get": {
"tags": [
"Vendor Return Release"
],
"summary": "Gets a list of Vendor Return Release records",
"description": "By default a vendor return release response will include only the fields: comments, jobNumber, lastModDate, lastModUser, POReleaseUniqueId, quantityToCancel, quantityToReject, releaseQuantity, vendReturnItemNumber, vendReturnNumber, uniqueID. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Job Number": {
"value": {
"jobNumber": "1234"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorReturnReleasesListSuccessResponse"
},
"example": {
"Data": [
{
"comments": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"POReleaseUniqueId": 0,
"quantityToCancel": 0,
"quantityToReject": 0,
"releaseQuantity": 0,
"uniqueID": 0,
"vendorReturnItemNumber": 0,
"vendorReturnNumber": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/vendors": {
"get": {
"tags": [
"Vendors"
],
"summary": "Gets a list of Vendors",
"description": "By default a vendor response will include only the fields: active, comments2, currencyCode, enteredDate, federalIDNumber, GLAccount1, lastModDate, leadTime, termsCode, uniqueID, vendorAccountNumber, vendorCode, vendorName, vendorType. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Type": {
"value": {
"vendorType": "STEEL"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorListSuccessResponse"
},
"example": {
"Data": [
{
"accountingID": "string",
"active": false,
"ARContact": "string",
"ARPhone": "string",
"averageDaysToPay": 0,
"comments1": "string",
"comments2": "string",
"currencyCode": "string",
"dateLast": "2026-09-06T17:13:13.0000000+00:00",
"dateOpen": "2026-09-06T17:13:13.0000000+00:00",
"defaultEmployeeCode": "string",
"defaultFOB": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"FAX": "string",
"federalIDNumber": "string",
"form1099Vendor": false,
"GLAccount1": "string",
"GSTCode": "string",
"isWebUser": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"markup": 0,
"minimumOrder": 0,
"outsideService": false,
"phone": "string",
"printTicket": false,
"purchasingAddress1": "string",
"purchasingCity": "string",
"purchasingContact": "string",
"purchasingCountry": "string",
"purchasingPhone": "string",
"purchasingState": "string",
"purchasingZipCode": "string",
"QBVendorCode": "string",
"remittanceAddress1": "string",
"remittanceCity": "string",
"remittanceCountry": "string",
"remittanceState": "string",
"remittanceZipCode": "string",
"restockingPercent": 0,
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"salesTaxCode": "string",
"setupCharge": 0,
"shipCode": "string",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipVia": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorAccountNumber": "string",
"vendorCode": "string",
"vendorName": "string",
"vendorType": "string",
"website": "string",
"workdayBegin": "string",
"workdayEnd": "string",
"workSaturday": false,
"workSunday": false,
"YTDPurchases": 0
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Vendors"
],
"summary": "Creates a Vendor",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorCreate"
},
"example": {
"active": false,
"comments1": "string",
"comments2": "string",
"currencyCode": "string",
"defaultEmployeeCode": "string",
"FAX": "string",
"federalIDNumber": "string",
"form1099Vendor": false,
"GLAccount1": "string",
"GSTCode": "string",
"leadTime": 0,
"markup": 0,
"minimumOrder": 0,
"outsideService": false,
"phone": "string",
"purchasingAddress1": "string",
"purchasingCity": "string",
"purchasingContact": "string",
"purchasingCountry": "string",
"purchasingPhone": "string",
"purchasingState": "string",
"purchasingZipCode": "string",
"QBVendorCode": "string",
"remittanceAddress1": "string",
"remittanceCity": "string",
"remittanceCountry": "string",
"remittanceState": "string",
"remittanceZipCode": "string",
"restockingPercent": 0,
"salesTaxCode": "string",
"setupCharge": 0,
"shipCode": "string",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipVia": "string",
"termsCode": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorAccountNumber": "string",
"vendorCode": "string",
"vendorName": "string",
"vendorType": "string",
"website": "string"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vendor"
},
"example": {
"accountingID": "string",
"active": false,
"ARContact": "string",
"ARPhone": "string",
"averageDaysToPay": 0,
"comments1": "string",
"comments2": "string",
"currencyCode": "string",
"dateLast": "2026-09-06T17:13:13.0000000+00:00",
"dateOpen": "2026-09-06T17:13:13.0000000+00:00",
"defaultEmployeeCode": "string",
"defaultFOB": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"FAX": "string",
"federalIDNumber": "string",
"form1099Vendor": false,
"GLAccount1": "string",
"GSTCode": "string",
"isWebUser": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"markup": 0,
"minimumOrder": 0,
"outsideService": false,
"phone": "string",
"printTicket": false,
"purchasingAddress1": "string",
"purchasingCity": "string",
"purchasingContact": "string",
"purchasingCountry": "string",
"purchasingPhone": "string",
"purchasingState": "string",
"purchasingZipCode": "string",
"QBVendorCode": "string",
"remittanceAddress1": "string",
"remittanceCity": "string",
"remittanceCountry": "string",
"remittanceState": "string",
"remittanceZipCode": "string",
"restockingPercent": 0,
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"salesTaxCode": "string",
"setupCharge": 0,
"shipCode": "string",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipVia": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorAccountNumber": "string",
"vendorCode": "string",
"vendorName": "string",
"vendorType": "string",
"website": "string",
"workdayBegin": "string",
"workdayEnd": "string",
"workSaturday": false,
"workSunday": false,
"YTDPurchases": 0
}
}
}
}
}
}
},
"/api/v1/vendors/{vendorCode}": {
"get": {
"tags": [
"Vendors"
],
"summary": "Gets a Vendor by vendor code",
"description": "By default a vendor response will include only the fields: active, comments2, currencyCode, enteredDate, federalIDNumber, GLAccount1, lastModDate, leadTime, termsCode, uniqueID, vendorAccountNumber, vendorCode, vendorName, vendorType. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "vendorCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorSuccessResponse"
},
"example": {
"Data": {
"accountingID": "string",
"active": false,
"ARContact": "string",
"ARPhone": "string",
"averageDaysToPay": 0,
"comments1": "string",
"comments2": "string",
"currencyCode": "string",
"dateLast": "2026-09-06T17:13:13.0000000+00:00",
"dateOpen": "2026-09-06T17:13:13.0000000+00:00",
"defaultEmployeeCode": "string",
"defaultFOB": "string",
"enteredBy": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"FAX": "string",
"federalIDNumber": "string",
"form1099Vendor": false,
"GLAccount1": "string",
"GSTCode": "string",
"isWebUser": false,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"leadTime": 0,
"markup": 0,
"minimumOrder": 0,
"outsideService": false,
"phone": "string",
"printTicket": false,
"purchasingAddress1": "string",
"purchasingCity": "string",
"purchasingContact": "string",
"purchasingCountry": "string",
"purchasingPhone": "string",
"purchasingState": "string",
"purchasingZipCode": "string",
"QBVendorCode": "string",
"remittanceAddress1": "string",
"remittanceCity": "string",
"remittanceCountry": "string",
"remittanceState": "string",
"remittanceZipCode": "string",
"restockingPercent": 0,
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"salesTaxCode": "string",
"setupCharge": 0,
"shipCode": "string",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipVia": "string",
"termsCode": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorAccountNumber": "string",
"vendorCode": "string",
"vendorName": "string",
"vendorType": "string",
"website": "string",
"workdayBegin": "string",
"workdayEnd": "string",
"workSaturday": false,
"workSunday": false,
"YTDPurchases": 0
}
}
}
}
}
}
},
"patch": {
"tags": [
"Vendors"
],
"summary": "Updates a Vendor",
"parameters": [
{
"name": "vendorCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorUpdate"
},
"example": {
"active": false,
"comments1": "string",
"comments2": "string",
"currencyCode": "string",
"defaultEmployeeCode": "string",
"federalIDNumber": "string",
"form1099Vendor": false,
"GLAccount1": "string",
"GSTCode": "string",
"leadTime": 0,
"markup": 0,
"outsideService": false,
"purchasingAddress1": "string",
"purchasingCity": "string",
"purchasingContact": "string",
"purchasingCountry": "string",
"purchasingPhone": "string",
"purchasingState": "string",
"purchasingZipCode": "string",
"remittanceAddress1": "string",
"remittanceCity": "string",
"remittanceCountry": "string",
"remittanceState": "string",
"remittanceZipCode": "string",
"restockingPercent": 0,
"salesTaxCode": "string",
"setupCharge": 0,
"shipCode": "string",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingCountry": "string",
"shippingState": "string",
"shippingZipCode": "string",
"shipVia": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"vendorAccountNumber": "string",
"vendorName": "string",
"vendorType": "string",
"website": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
},
"/api/v1/work-center-maintenance": {
"get": {
"tags": [
"Work Center Maintenance"
],
"summary": "Gets a list of Work Center Maintenance records",
"description": "By default a Work Center maintenance response will include only the fields: completed, cost, description, employeeCode, endDate, invoiceNumber, jobNumber, lastModDate, lastModUser, startDate, vendorCode, wcMaintCode, uniqueID, workCenter, workCenterName. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Work Center Name": {
"value": {
"workCenterName": "CNC Lathe"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkCenterMaintenanceListSuccessResponse"
},
"example": {
"Data": [
{
"completed": false,
"cost": 0,
"description": "string",
"employeeCode": "string",
"endDate": "2026-09-06T17:13:13.0000000+00:00",
"invoiceNumber": "string",
"jobNumber": "string",
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"startDate": "2026-09-06T17:13:13.0000000+00:00",
"uniqueID": 0,
"vendorCode": "string",
"wcMaintCode": "string",
"workCenter": "string",
"workCenterName": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/work-centers": {
"get": {
"tags": [
"Work Centers"
],
"summary": "Gets a list of Work Centers",
"description": "By default a work center response will include only the fields: active, attendanceCode, burdenRate, capacityFactor, comments, departmentNumber, description, laborAccount, laborRate, lastModDate, operationCode, queueTime, queueUnit, shortName, uniqueID, workCenter. You may specify the exact fields to return using the fields parameter.",
"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 field to sort by. See the Sort Expressions section for more information.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "Filters must be provided as query string parameters as defined in the Filter Expressions section.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": {
"No filters": { },
"Filter by Department": {
"value": {
"departmentNumber": "PRODUCT"
}
}
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records at the start of the result set to skip over.",
"schema": {
"type": "string"
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to retrieve.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkCenterListSuccessResponse"
},
"example": {
"Data": [
{
"active": false,
"attendanceCode": "string",
"burdenRate": 0,
"capacityFactor": 0,
"cycle1": 0,
"cycle10": 0,
"cycle2": 0,
"cycle3": 0,
"cycle4": 0,
"cycle5": 0,
"cycle6": 0,
"cycle7": 0,
"cycle8": 0,
"cycle9": 0,
"defaultEmployeeCode": "string",
"defaultSetupTime": 0,
"defaultTimeUnit": "string",
"departmentNumber": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"hoursAvailable": 0,
"hoursAvailableShift1": 0,
"hoursAvailableShift2": 0,
"hoursAvailableShift3": 0,
"imageRepositoryID": 0,
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"loadingMethod": "string",
"locationLeft": 0,
"locationTop": 0,
"operationCode": "string",
"queueTime": 0,
"queueUnit": "string",
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"runOnShift1": false,
"runOnShift2": false,
"runOnShift3": false,
"scheduleBegin": "string",
"scheduleEnd": "string",
"setup1": 0,
"setup10": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setup9": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"shortName": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"utilizationPercent": 0,
"workCenter": 0,
"workCenterImageFile": "string",
"workFriday": false,
"workMonday": false,
"workSaturday": false,
"workSunday": false,
"workThursday": false,
"workTuesday": false,
"workWednesday": false
}
]
}
}
}
}
}
},
"post": {
"tags": [
"Work Centers"
],
"summary": "Creates a Work Center",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkCenterCreate"
},
"example": {
"active": false,
"attendanceCode": "string",
"burdenRate": 0,
"capacityFactor": 0,
"cycle1": 0,
"cycle10": 0,
"cycle2": 0,
"cycle3": 0,
"cycle4": 0,
"cycle5": 0,
"cycle6": 0,
"cycle7": 0,
"cycle8": 0,
"cycle9": 0,
"departmentNumber": "string",
"description": "string",
"laborAccount": "string",
"laborRate": 0,
"operationCode": "string",
"setup1": 0,
"setup10": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setup9": 0,
"shortName": "string",
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"workCenter": 0
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkCenter"
},
"example": {
"active": false,
"attendanceCode": "string",
"burdenRate": 0,
"capacityFactor": 0,
"cycle1": 0,
"cycle10": 0,
"cycle2": 0,
"cycle3": 0,
"cycle4": 0,
"cycle5": 0,
"cycle6": 0,
"cycle7": 0,
"cycle8": 0,
"cycle9": 0,
"defaultEmployeeCode": "string",
"defaultSetupTime": 0,
"defaultTimeUnit": "string",
"departmentNumber": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"hoursAvailable": 0,
"hoursAvailableShift1": 0,
"hoursAvailableShift2": 0,
"hoursAvailableShift3": 0,
"imageRepositoryID": 0,
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"loadingMethod": "string",
"locationLeft": 0,
"locationTop": 0,
"operationCode": "string",
"queueTime": 0,
"queueUnit": "string",
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"runOnShift1": false,
"runOnShift2": false,
"runOnShift3": false,
"scheduleBegin": "string",
"scheduleEnd": "string",
"setup1": 0,
"setup10": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setup9": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"shortName": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"utilizationPercent": 0,
"workCenter": 0,
"workCenterImageFile": "string",
"workFriday": false,
"workMonday": false,
"workSaturday": false,
"workSunday": false,
"workThursday": false,
"workTuesday": false,
"workWednesday": false
}
}
}
}
}
}
},
"/api/v1/work-centers/{workCenter}": {
"get": {
"tags": [
"Work Centers"
],
"summary": "Gets a Work Center by work center code",
"description": "By default a work center response will include only the fields: active, attendanceCode, burdenRate, capacityFactor, comments, departmentNumber, description, laborAccount, laborRate, lastModDate, operationCode, queueTime, queueUnit, shortName, uniqueID, workCenter. You may specify the exact fields to return using the fields parameter.",
"parameters": [
{
"name": "workCenter",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"description": "A comma separated list of fields to include in the result.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkCenterSuccessResponse"
},
"example": {
"Data": {
"active": false,
"attendanceCode": "string",
"burdenRate": 0,
"capacityFactor": 0,
"cycle1": 0,
"cycle10": 0,
"cycle2": 0,
"cycle3": 0,
"cycle4": 0,
"cycle5": 0,
"cycle6": 0,
"cycle7": 0,
"cycle8": 0,
"cycle9": 0,
"defaultEmployeeCode": "string",
"defaultSetupTime": 0,
"defaultTimeUnit": "string",
"departmentNumber": "string",
"description": "string",
"enteredDate": "2026-09-06T17:13:13.0000000+00:00",
"hoursAvailable": 0,
"hoursAvailableShift1": 0,
"hoursAvailableShift2": 0,
"hoursAvailableShift3": 0,
"imageRepositoryID": 0,
"laborAccount": "string",
"laborRate": 0,
"lastModDate": "2026-09-06T17:13:13.0000000+00:00",
"lastModUser": "string",
"loadingMethod": "string",
"locationLeft": 0,
"locationTop": 0,
"operationCode": "string",
"queueTime": 0,
"queueUnit": "string",
"revisedDate": "2026-09-06T17:13:13.0000000+00:00",
"runOnShift1": false,
"runOnShift2": false,
"runOnShift3": false,
"scheduleBegin": "string",
"scheduleEnd": "string",
"setup1": 0,
"setup10": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setup9": 0,
"shift2DefaultEmployeeCode": "string",
"shift3DefaultEmployeeCode": "string",
"shortName": "string",
"uniqueID": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string",
"utilizationPercent": 0,
"workCenter": 0,
"workCenterImageFile": "string",
"workFriday": false,
"workMonday": false,
"workSaturday": false,
"workSunday": false,
"workThursday": false,
"workTuesday": false,
"workWednesday": false
}
}
}
}
}
}
},
"patch": {
"tags": [
"Work Centers"
],
"summary": "Updates a Work Center",
"parameters": [
{
"name": "workCenter",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkCenterUpdate"
},
"example": {
"active": false,
"attendanceCode": "string",
"burdenRate": 0,
"cycle1": 0,
"cycle10": 0,
"cycle2": 0,
"cycle3": 0,
"cycle4": 0,
"cycle5": 0,
"cycle6": 0,
"cycle7": 0,
"cycle8": 0,
"cycle9": 0,
"departmentNumber": "string",
"description": "string",
"laborAccount": "string",
"laborRate": 0,
"operationCode": "string",
"setup1": 0,
"setup10": 0,
"setup2": 0,
"setup3": 0,
"setup4": 0,
"setup5": 0,
"setup6": 0,
"setup7": 0,
"setup8": 0,
"setup9": 0,
"user_Currency1": 0,
"user_Currency2": 0,
"user_Date1": "2026-09-06T17:13:13.0000000+00:00",
"user_Date2": "2026-09-06T17:13:13.0000000+00:00",
"user_Memo1": "string",
"user_Number1": 0,
"user_Number2": 0,
"user_Number3": 0,
"user_Number4": 0,
"user_Text1": "string",
"user_Text2": "string",
"user_Text3": "string",
"user_Text4": "string"
}
}
}
},
"responses": {
"204": {
"description": "Success"
}
}
}
}
},
"components": {
"schemas": {
"ARInvoice": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"amountPaidSoFar": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"amountPaidSoFarForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"ARAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cashDiscountAmount": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cashDiscountAmountForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"country": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCheckNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"daysOverdue": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"deliverTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"discountAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"discountDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"exportedToEDI": {
"type": "boolean",
"readOnly": true
},
"exportedToQB": {
"type": "boolean",
"readOnly": true
},
"freightAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"GSTChargesForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"GSTCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ignoreMinimumOrder": {
"type": "boolean",
"readOnly": true
},
"invoiceDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"invoicePosted": {
"type": "boolean",
"readOnly": true
},
"invoicePrinted": {
"type": "boolean",
"readOnly": true
},
"invoiceTotal": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"invoiceTotalForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"netDueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"notes": {
"type": "string",
"nullable": true,
"readOnly": true
},
"openInvoiceAmount": {
"type": "number",
"format": "double",
"readOnly": true
},
"paymentDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"paymentStatus": {
"type": "string",
"nullable": true,
"readOnly": true
},
"periodNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"projectedPayDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"salesID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesTaxCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesTaxChargesForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shippingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shippingChargesForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shippingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingStreet": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingZip": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipToName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"territory": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ARInvoiceDetail": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"commissionPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"contactName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deliveryTicketDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"discountPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"FOB": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLAccount1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLAccount2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLAccount3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLAccount4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLAccount5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inventoryItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isTaxable": {
"type": "boolean",
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lineTotal": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lineTotalForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityCancelled": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityOrdered": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityShipped": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesAmount1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmount2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmount3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmount4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmount5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmountForeign1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmountForeign2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmountForeign3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmountForeign4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesAmountForeign5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"taxStatus": {
"type": "boolean",
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unitPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"unitPriceForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ARInvoiceDetailListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ARInvoiceDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ARInvoiceListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ARInvoice"
},
"nullable": true
}
},
"additionalProperties": false
},
"AttendanceTicketCreate": {
"required": [
"employeeCode",
"ticketDate"
],
"type": "object",
"properties": {
"employeeCode": {
"type": "integer",
"format": "int32"
},
"ticketDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"BinLocation": {
"type": "object",
"properties": {
"binLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"datePosted": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"POItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityOnHand": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"receiverNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"BinLocationListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BinLocation"
},
"nullable": true
}
},
"additionalProperties": false
},
"Company": {
"type": "object",
"properties": {
"accountsPayableAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"accountsReceivableAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingDrivenBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription10": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRateDescription9": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cashDiscountAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"companyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"companyCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"companyDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"companyTimeZone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currentEarningsAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"freightAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription10": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payrollRateDescription9": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchaseDiscountAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reportDateFormat": {
"type": "string",
"nullable": true,
"readOnly": true
},
"retainedEarningsAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"useA4PaperSize": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"CompanyCalendar": {
"type": "object",
"properties": {
"calendarType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"capacityFactor": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"code": {
"type": "string",
"nullable": true,
"readOnly": true
},
"date": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"hoursAvailable": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"hoursAvailableShift1": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"hoursAvailableShift2": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"hoursAvailableShift3": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"scheduleBegin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"scheduleEnd": {
"type": "string",
"nullable": true,
"readOnly": true
},
"searchDate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"shift1Begin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift1DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift1End": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift2Begin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift2CapacityFactor": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"shift2DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift2End": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift3Begin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift3CapacityFactor": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"shift3DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift3End": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"CompanyCalendarListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyCalendar"
},
"nullable": true
}
},
"additionalProperties": false
},
"CompanyListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Company"
},
"nullable": true
}
},
"additionalProperties": false
},
"Contact": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"cellPhone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contactCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"email": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"extension": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fax": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isOptedOut": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mobileEmail": {
"type": "string",
"nullable": true,
"readOnly": true
},
"object": {
"type": "string",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"ContactCreate": {
"required": [
"contact",
"contactCode",
"object"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"cellPhone": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"contact": {
"type": "string"
},
"contactCode": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"extension": {
"type": "string",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"isOptedOut": {
"type": "boolean"
},
"mobileEmail": {
"type": "string",
"nullable": true
},
"object": {
"type": "string"
},
"phone": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ContactListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
},
"nullable": true
}
},
"additionalProperties": false
},
"ContactSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Contact"
}
},
"additionalProperties": false
},
"ContactUpdate": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"cellPhone": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"extension": {
"type": "string",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CorrectiveAction": {
"type": "object",
"properties": {
"authorization": {
"type": "string",
"nullable": true,
"readOnly": true
},
"carDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"carJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"carPrinted": {
"type": "string",
"nullable": true,
"readOnly": true
},
"closeOutDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"correctiveActionCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enterBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enterDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"feedbackNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"immediateAction": {
"type": "string",
"nullable": true,
"readOnly": true
},
"implementationDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"permanentAction": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"qualityControlManager": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityReturned": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToRework": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"reasonForReturn": {
"type": "string",
"nullable": true,
"readOnly": true
},
"responseDue": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"returnType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"rmaItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"rootCause": {
"type": "string",
"nullable": true,
"readOnly": true
},
"signatureOnFile": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorReturnNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"verificationBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"verificationDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"verificationOfEffectiveness": {
"type": "string",
"nullable": true,
"readOnly": true
},
"verificationOfEffectivenessBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"verificationOfImplementation": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"CorrectiveActionListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CorrectiveAction"
},
"nullable": true
}
},
"additionalProperties": false
},
"CorrectiveActionSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/CorrectiveAction"
}
},
"additionalProperties": false
},
"CurrencyCode": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"buyRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyFormat": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencySymbol": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"decimalPlaces": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"decimalSymbol": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"formatShow": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"negativeCurrencyFormat": {
"type": "string",
"nullable": true,
"readOnly": true
},
"negativeFormatShow": {
"type": "string",
"nullable": true,
"readOnly": true
},
"QBCurrencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"sellRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"thousandsSeparator": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"CurrencyCodeListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyCode"
},
"nullable": true
}
},
"additionalProperties": false
},
"Customer": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active": {
"type": "boolean",
"readOnly": true
},
"APContact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"APPhone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"averageDaysToPay": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"averageReceiptAge": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"billingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingState": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingZIPCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contact1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contact1Phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contact2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contact2Phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creditLimit": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"creditStatus": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currentReceivableBalance": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateLast": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dateOpen": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"defaultPriority": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"fax": {
"type": "string",
"nullable": true,
"readOnly": true
},
"federalIDNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"minimumOrder": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"NET1ContactID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"priceTier": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"QBCustomerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"restockingPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"salesID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"website": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"YTDSales": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"CustomerCreate": {
"required": [
"customerCode",
"customerName"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"billingAddress1": {
"type": "string",
"nullable": true
},
"billingCity": {
"type": "string",
"nullable": true
},
"billingCountry": {
"type": "string",
"nullable": true
},
"billingState": {
"type": "string",
"nullable": true
},
"billingZIPCode": {
"type": "string",
"nullable": true
},
"comments1": {
"type": "string",
"nullable": true
},
"comments2": {
"type": "string",
"nullable": true
},
"creditLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"creditStatus": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"customerCode": {
"type": "string"
},
"customerName": {
"type": "string"
},
"defaultPriority": {
"type": "integer",
"format": "int32",
"nullable": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"federalIDNumber": {
"type": "string",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"minimumOrder": {
"type": "number",
"format": "double",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"QBCustomerCode": {
"type": "string",
"nullable": true
},
"salesID": {
"type": "string",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"termsCode": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
},
"workCode": {
"type": "string",
"nullable": true
},
"shippingAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerShippingAddressCreate"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomerListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomerReturn": {
"type": "object",
"properties": {
"billCustomerForReturn": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCAR": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCreditMemo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createdInvoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createNC": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creditDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"creditedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"debitPrinted": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inspectedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inspectionDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"issuedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"labelPrinted": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"orderedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"QCComment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reasonForReturn": {
"type": "string",
"nullable": true,
"readOnly": true
},
"receiveDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"receivedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"receivingComment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"CustomerReturnLineItem": {
"type": "object",
"properties": {
"binLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCAR": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createNC": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deliveryTicketItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ncNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"originalJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"originalOrderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"originalQuantityShipped": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityGood": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityReturned": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToRestock": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToRework": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"reasonCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"restockingPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"reworkJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"rmaItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"CustomerReturnLineItemListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerReturnLineItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomerReturnListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerReturn"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomerReturnReleaseApi": {
"type": "object",
"properties": {
"binLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityToRestock": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToRework": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"rmaItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"CustomerReturnReleaseApiListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerReturnReleaseApi"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomerShippingAddressCreate": {
"required": [
"location"
],
"type": "object",
"properties": {
"location": {
"type": "string"
},
"printCertification": {
"type": "boolean"
},
"shippingAddress1": {
"type": "string",
"nullable": true
},
"shippingCity": {
"type": "string",
"nullable": true
},
"shippingCode": {
"type": "string",
"nullable": true
},
"shippingContact": {
"type": "string",
"nullable": true
},
"shippingCountry": {
"type": "string",
"nullable": true
},
"shippingFAX": {
"type": "string",
"nullable": true
},
"shippingPhone": {
"type": "string",
"nullable": true
},
"shippingState": {
"type": "string",
"nullable": true
},
"shippingZipCode": {
"type": "string",
"nullable": true
},
"shipToName": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"territory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomerSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Customer"
}
},
"additionalProperties": false
},
"CustomerUpdate": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"billingAddress1": {
"type": "string",
"nullable": true
},
"billingCity": {
"type": "string",
"nullable": true
},
"billingCountry": {
"type": "string",
"nullable": true
},
"billingState": {
"type": "string",
"nullable": true
},
"billingZIPCode": {
"type": "string",
"nullable": true
},
"comments1": {
"type": "string",
"nullable": true
},
"comments2": {
"type": "string",
"nullable": true
},
"creditLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"federalIDNumber": {
"type": "string",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Department": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"departmentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"DepartmentListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Department"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentControl": {
"type": "object",
"properties": {
"approvalComments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"approvalDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"approvedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"documentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentStatus": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fileLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"printed": {
"type": "string",
"nullable": true,
"readOnly": true
},
"proposalComments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"proposalDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"proposedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"releaseComments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"releaseDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"releasedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"repositoryID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"retiredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"retirementComments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"retirementDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"DocumentControlHistory": {
"type": "object",
"properties": {
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fileLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"repositoryID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"spunOffFile": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"updatedJobs": {
"type": "string",
"nullable": true,
"readOnly": true
},
"updatedParts": {
"type": "string",
"nullable": true,
"readOnly": true
},
"userID": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"DocumentControlHistoryListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentControlHistory"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentControlListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentControl"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentReview": {
"type": "object",
"properties": {
"completed": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cost": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reviewCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"DocumentReviewListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentReview"
},
"nullable": true
}
},
"additionalProperties": false
},
"Employee": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active": {
"type": "boolean",
"readOnly": true
},
"address1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"allowBatchAtClock": {
"type": "boolean",
"readOnly": true
},
"applyAutoBreak": {
"type": "boolean",
"readOnly": true
},
"break1Duration": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"break1Time": {
"type": "string",
"nullable": true,
"readOnly": true
},
"break2Duration": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"break2Time": {
"type": "string",
"nullable": true,
"readOnly": true
},
"break3Duration": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"break3Time": {
"type": "string",
"nullable": true,
"readOnly": true
},
"break4Duration": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"break4Time": {
"type": "string",
"nullable": true,
"readOnly": true
},
"city": {
"type": "string",
"nullable": true,
"readOnly": true
},
"companyShipToLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"country": {
"type": "string",
"nullable": true,
"readOnly": true
},
"defaultPayrollRate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"departmentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeCodeImageFile": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeShortName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"geoFenceRadius": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"hireDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"imageRepositoryID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"isDataCollectionUser": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"isGeoFenceEnabled": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"isSSIDFenceEnabled": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastReview": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"nextReview": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"notes": {
"type": "string",
"nullable": true,
"readOnly": true
},
"overtimeFactor": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"overtimeMethod": {
"type": "string",
"nullable": true,
"readOnly": true
},
"overtimeThreshold": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"rate1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate10": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"rate9": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shiftBegin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shiftEnd": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shiftID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"signatureImageFile": {
"type": "string",
"nullable": true,
"readOnly": true
},
"signatureRepositoryID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"SSID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"state": {
"type": "string",
"nullable": true,
"readOnly": true
},
"terminationDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"userID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workFriday": {
"type": "boolean",
"readOnly": true
},
"workMonday": {
"type": "boolean",
"readOnly": true
},
"workSaturday": {
"type": "boolean",
"readOnly": true
},
"workSunday": {
"type": "boolean",
"readOnly": true
},
"workThursday": {
"type": "boolean",
"readOnly": true
},
"workTuesday": {
"type": "boolean",
"readOnly": true
},
"workWednesday": {
"type": "boolean",
"readOnly": true
},
"zipCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"EmployeeListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
},
"nullable": true
}
},
"additionalProperties": false
},
"EmployeeTraining": {
"type": "object",
"properties": {
"completed": {
"type": "boolean",
"readOnly": true
},
"cost": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"instructor": {
"type": "string",
"nullable": true,
"readOnly": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"trainingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"EmployeeTrainingListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeTraining"
},
"nullable": true
}
},
"additionalProperties": false
},
"EmployeeUpdate": {
"type": "object",
"properties": {
"departmentNumber": {
"type": "string",
"nullable": true
},
"employeeName": {
"type": "string",
"nullable": true
},
"rate1": {
"type": "number",
"format": "double",
"nullable": true
},
"shiftID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ErrorResponse": {
"type": "object",
"properties": {
"Error": {
"$ref": "#/components/schemas/ErrorSchema"
}
},
"additionalProperties": false
},
"ErrorSchema": {
"type": "object",
"properties": {
"Title": {
"type": "string",
"nullable": true
},
"Status": {
"type": "integer",
"format": "int32"
},
"Detail": {
"type": "string",
"nullable": true
},
"TraceId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Estimate": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active": {
"type": "boolean",
"readOnly": true
},
"alternatePartNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"bin1Lot": {
"type": "string",
"nullable": true,
"readOnly": true
},
"bin2Lot": {
"type": "string",
"nullable": true,
"readOnly": true
},
"bin3Lot": {
"type": "string",
"nullable": true,
"readOnly": true
},
"bin4Lot": {
"type": "string",
"nullable": true,
"readOnly": true
},
"bin5Lot": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binQuantity1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"binQuantity2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"binQuantity3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"binQuantity4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"binQuantity5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"calculationMethod": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"defaultBinLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"drawingFileName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"drawingNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"imageRepositoryID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"inspectCustomerReturns": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"inspectInternalRejections": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"inspectOrders": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"inspectReceivers": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"isTaxable": {
"type": "boolean",
"readOnly": true
},
"lastDeliveryTicketDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastDeliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastDeliveryTicketQuantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"lastJobDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastJobDateFinished": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastJobPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastJobQuantity": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastJobQuoteNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastPriceChange": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastPurchaseOrderCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastPurchaseOrderDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastPurchaseOrderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastPurchaseOrderQuantity": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"lockPrice": {
"type": "boolean",
"readOnly": true
},
"markup1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markup8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"markupPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"matchQuantityBreaks": {
"type": "boolean",
"readOnly": true
},
"miscCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partWeight": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"pricingUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"printed": {
"type": "boolean",
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchaseCost1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseCost8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseFactor": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseQuantity1": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity2": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity3": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity4": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity5": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity6": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity7": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchaseQuantity8": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchasingGLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"QBItemType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantity1": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity2": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity3": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity4": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity5": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity6": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity7": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity8": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityOnHand": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityOnOrder": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityOutside": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"reOrderLevel": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"reOrderQuantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"routeDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"routeEmployee": {
"type": "string",
"nullable": true,
"readOnly": true
},
"stockingCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"stockUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"useDefaultQuantities": {
"type": "boolean",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode3": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"EstimateCreate": {
"required": [
"partNumber"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"alternatePartNumber": {
"type": "string",
"nullable": true
},
"calculationMethod": {
"type": "string",
"nullable": true
},
"customerCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"GLCode": {
"type": "string",
"nullable": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lockPrice": {
"type": "boolean"
},
"markup1": {
"type": "number",
"format": "double",
"nullable": true
},
"markup2": {
"type": "number",
"format": "double",
"nullable": true
},
"markup3": {
"type": "number",
"format": "double",
"nullable": true
},
"markup4": {
"type": "number",
"format": "double",
"nullable": true
},
"markup5": {
"type": "number",
"format": "double",
"nullable": true
},
"markup6": {
"type": "number",
"format": "double",
"nullable": true
},
"markup7": {
"type": "number",
"format": "double",
"nullable": true
},
"markup8": {
"type": "number",
"format": "double",
"nullable": true
},
"partNumber": {
"type": "string"
},
"partWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"price1": {
"type": "number",
"format": "double",
"nullable": true
},
"price2": {
"type": "number",
"format": "double",
"nullable": true
},
"price3": {
"type": "number",
"format": "double",
"nullable": true
},
"price4": {
"type": "number",
"format": "double",
"nullable": true
},
"price5": {
"type": "number",
"format": "double",
"nullable": true
},
"price6": {
"type": "number",
"format": "double",
"nullable": true
},
"price7": {
"type": "number",
"format": "double",
"nullable": true
},
"price8": {
"type": "number",
"format": "double",
"nullable": true
},
"pricingUnit": {
"type": "string",
"nullable": true
},
"productCode": {
"type": "string",
"nullable": true
},
"purchaseCost1": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost2": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost3": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost4": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost5": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost6": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost7": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseCost8": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseFactor": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseQuantity1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity2": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity3": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity4": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity5": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity6": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity7": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseQuantity8": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchasingGLCode": {
"type": "string",
"nullable": true
},
"purchasingUnit": {
"type": "string",
"nullable": true
},
"quantity1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity2": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity3": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity4": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity5": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity6": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity7": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity8": {
"type": "integer",
"format": "int32",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"useDefaultQuantities": {
"type": "boolean"
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"vendorCode1": {
"type": "string",
"nullable": true
},
"materials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaterialCreate"
},
"nullable": true
},
"routings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoutingCreate"
},
"nullable": true
}
},
"additionalProperties": false
},
"EstimateListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Estimate"
},
"nullable": true
}
},
"additionalProperties": false
},
"EstimateSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Estimate"
}
},
"additionalProperties": false
},
"EstimateUpdate": {
"type": "object",
"properties": {
"revision": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Feedback": {
"type": "object",
"properties": {
"closeOut": {
"type": "string",
"nullable": true,
"readOnly": true
},
"closeOutDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCAR": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enterBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enterDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"fax": {
"type": "string",
"nullable": true,
"readOnly": true
},
"feedbackCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"feedbackDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"feedbackNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"feedbackType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"managerCloseOut": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"resolution": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"FeedbackListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Feedback"
},
"nullable": true
}
},
"additionalProperties": false
},
"GLAccount": {
"type": "object",
"properties": {
"accountingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"accumulationAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active": {
"type": "boolean",
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"division": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"GLAccountNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"GLAccountListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GLAccount"
},
"nullable": true
}
},
"additionalProperties": false
},
"GLAccountSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/GLAccount"
}
},
"additionalProperties": false
},
"JobMaterial": {
"type": "object",
"properties": {
"binLocation1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocation5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"binLocationCounter": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"datePosted": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobClosedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"jobStatus": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mainPart": {
"type": "boolean",
"readOnly": true
},
"manufacturingJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"originalBinCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"outsideService": {
"type": "boolean",
"readOnly": true
},
"packingListDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"packingListNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PODate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"POItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"postedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"postedFromStock": {
"type": "boolean",
"readOnly": true
},
"pricingUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityPosted1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityPosted2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityPosted3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityPosted4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityPosted5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"receiverDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"receiverNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"resalePrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"stockingCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"stockUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"subAssemblyJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorInvoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorType": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"JobMaterialListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobMaterial"
},
"nullable": true
}
},
"additionalProperties": false
},
"JobMaterialSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/JobMaterial"
}
},
"additionalProperties": false
},
"JobRequirement": {
"type": "object",
"properties": {
"certificationRequired": {
"type": "boolean",
"readOnly": true
},
"cost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"dateProcessed": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobDue": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"outsideService": {
"type": "boolean",
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PODate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"POItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"pricingUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchaseQuantity": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"purchaseUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityToBuy": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"stockingUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"temporaryJobDue": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"JobRequirementListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobRequirement"
},
"nullable": true
}
},
"additionalProperties": false
},
"JobRequirementSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/JobRequirement"
}
},
"additionalProperties": false
},
"Material": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"isPurchased": {
"type": "boolean",
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"materialDetailID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partWeight": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"subPartNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"totalCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalQuantity": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalWeight": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unitCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"unitPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"vendor": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"MaterialCreate": {
"required": [
"subPartNumber"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"materialDetailID": {
"type": "string",
"nullable": true
},
"partWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subPartNumber": {
"type": "string"
},
"unit": {
"type": "string",
"nullable": true
},
"unitCost": {
"type": "number",
"format": "double",
"nullable": true
},
"unitPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"vendor": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MaterialListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Material"
},
"nullable": true
}
},
"additionalProperties": false
},
"MaterialSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Material"
}
},
"additionalProperties": false
},
"NonConformance": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"department": {
"type": "string",
"nullable": true,
"readOnly": true
},
"disposition": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enterBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enterDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"inspectedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ncCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ncDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"ncDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ncNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ncPrinted": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"other": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"poNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"processDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityReturned": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"reasonCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"responsibleMgr": {
"type": "string",
"nullable": true,
"readOnly": true
},
"returnItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"returnNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"returnType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"NonConformanceListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NonConformance"
},
"nullable": true
}
},
"additionalProperties": false
},
"NonConformanceSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/NonConformance"
}
},
"additionalProperties": false
},
"ObjectSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"nullable": true
}
},
"additionalProperties": false
},
"OperationCode": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"defaultCycleTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"defaultCycleUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"defaultSetupTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"defaultTimeUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isUnattendedOperation": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"machinesJobRunOn": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"machinesRunByOperator": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"operationCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"operationNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"percentEfficiency": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"scrapPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"teamSize": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"OperationCodeListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationCode"
},
"nullable": true
}
},
"additionalProperties": false
},
"OperationCodeSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/OperationCode"
}
},
"additionalProperties": false
},
"Order": {
"type": "object",
"properties": {
"ackPrinted": {
"type": "boolean",
"readOnly": true
},
"addCustomerFromQuote": {
"type": "boolean",
"readOnly": true
},
"allowExpiredQuoteItems": {
"type": "boolean",
"readOnly": true
},
"country": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dateEnteredLabel": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"fax": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"holdUntilAccountIsCurrent": {
"type": "boolean",
"readOnly": true
},
"JTPrinted": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mainDueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"mainPriority": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"markCustomerActive": {
"type": "boolean",
"readOnly": true
},
"notesToCustomer": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderTotal": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"orderTotalForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingContact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quoteNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"saveOnDuplicateCustomerPONumber": {
"type": "boolean",
"readOnly": true
},
"shippingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingAddress2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingState": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipToName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipZIP": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"territory": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"WOPrinted": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"OrderCreate": {
"required": [
"customerCode"
],
"type": "object",
"properties": {
"addCustomerFromQuote": {
"type": "boolean"
},
"allowExpiredQuoteItems": {
"type": "boolean"
},
"country": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"customerCode": {
"type": "string"
},
"customerDescription": {
"type": "string",
"nullable": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"holdUntilAccountIsCurrent": {
"type": "boolean"
},
"location": {
"type": "string",
"nullable": true
},
"mainDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mainPriority": {
"type": "integer",
"format": "int32",
"nullable": true
},
"markCustomerActive": {
"type": "boolean"
},
"notesToCustomer": {
"type": "string",
"nullable": true
},
"orderNumber": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"PONumber": {
"type": "string",
"nullable": true
},
"purchasingContact": {
"type": "string",
"nullable": true
},
"quoteNumber": {
"type": "string",
"nullable": true
},
"salesID": {
"type": "string",
"nullable": true
},
"saveOnDuplicateCustomerPONumber": {
"type": "boolean"
},
"shippingAddress1": {
"type": "string",
"nullable": true
},
"shippingCity": {
"type": "string",
"nullable": true
},
"shippingCode": {
"type": "string",
"nullable": true
},
"shippingState": {
"type": "string",
"nullable": true
},
"shipToName": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"shipZIP": {
"type": "string",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"termsCode": {
"type": "string",
"nullable": true
},
"territory": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemCreate"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderLineItem": {
"type": "object",
"properties": {
"actualEndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"actualStartDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cumulativeBilling": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"currentWorkCenter": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateFinished": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"estimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"FOB": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isJobLabelPrinted": {
"type": "boolean",
"readOnly": true
},
"isScheduled": {
"type": "boolean",
"readOnly": true
},
"isTaxable": {
"type": "boolean",
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"jobNotes": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobOnHold": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"masterJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"masterStepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"miscCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscChargesBilled": {
"type": "boolean",
"readOnly": true
},
"miscChargesForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"overlapSteps": {
"type": "boolean",
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"pricingUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"priority": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityCanceled": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityOrdered": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityShippedToCustomer": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityShippedToStock": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToMake": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToStock": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quoteItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quoteNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"scheduleLocked": {
"type": "boolean",
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"tempPriority": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"totalActualHours": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalEstimatedHours": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"travelerPrinted": {
"type": "boolean",
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unitPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"unitPriceForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"OrderLineItemCreate": {
"required": [
"partNumber"
],
"type": "object",
"properties": {
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"FOB": {
"type": "string",
"nullable": true
},
"isTaxable": {
"type": "boolean"
},
"jobNotes": {
"type": "string",
"nullable": true
},
"miscCharges": {
"type": "number",
"format": "double",
"nullable": true
},
"miscDescription": {
"type": "string",
"nullable": true
},
"partDescription": {
"type": "string",
"nullable": true
},
"partNumber": {
"type": "string"
},
"pricingUnit": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32",
"nullable": true
},
"productCode": {
"type": "string",
"nullable": true
},
"quantityOrdered": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quoteItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quoteNumber": {
"type": "string",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"totalEstimatedHours": {
"type": "number",
"format": "double",
"nullable": true
},
"unitPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"workCode": {
"type": "string",
"nullable": true
},
"releases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseCreate"
},
"nullable": true
},
"orderRoutings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderRoutingCreate"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderLineItemListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderLineItemOrderRoutingUpdate": {
"type": "object",
"properties": {
"stepNumber": {
"type": "integer",
"format": "int32"
},
"operationCode": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workCenter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OrderLineItemSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/OrderLineItem"
}
},
"additionalProperties": false
},
"OrderLineItemUpdate": {
"type": "object",
"properties": {
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"orderRoutings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemOrderRoutingUpdate"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderRouting": {
"type": "object",
"properties": {
"actualEndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"actualPiecesGood": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"actualPiecesScrap": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"actualStartDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"burdenRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"certificationRequired": {
"type": "boolean",
"readOnly": true
},
"cost1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cyclePrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"departmentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"estimatedQuantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"estimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ignoreVendorMinimum": {
"type": "boolean",
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"jobClosedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"jobStatus": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"laborAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"laborRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"machinesRun": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"markupPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"numberMachinesForJob": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"operationCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"overlapSteps": {
"type": "boolean",
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"percentEfficient": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"scrapPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shift2DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift3DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"teamSize": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"tempEstimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"tempEstimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"timeUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"total": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalActualHours": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalEstimatedHours": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalHoursLeft": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"unattendedOperation": {
"type": "boolean",
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCenter": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCenterOrVendor": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"OrderRoutingCreate": {
"required": [
"workCenterOrVendor"
],
"type": "object",
"properties": {
"certificationRequired": {
"type": "boolean"
},
"cyclePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true
},
"cycleUnit": {
"type": "string",
"nullable": true
},
"departmentNumber": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedQuantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"estimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ignoreVendorMinimum": {
"type": "boolean"
},
"operationCode": {
"type": "string",
"nullable": true
},
"overlapSteps": {
"type": "boolean"
},
"setupPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true
},
"shift2DefaultEmployeeCode": {
"type": "string",
"nullable": true
},
"shift3DefaultEmployeeCode": {
"type": "string",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeUnit": {
"type": "string",
"nullable": true
},
"total": {
"type": "number",
"format": "double",
"nullable": true
},
"vendorCode": {
"type": "string",
"nullable": true
},
"workCenter": {
"type": "string",
"nullable": true
},
"workCenterOrVendor": {
"type": "string"
}
},
"additionalProperties": false
},
"OrderRoutingListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderRouting"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderRoutingSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/OrderRouting"
}
},
"additionalProperties": false
},
"OrderRoutingUpdate": {
"type": "object",
"properties": {
"operationCode": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workCenter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OrderSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Order"
}
},
"additionalProperties": false
},
"OrderUpdate": {
"type": "object",
"properties": {
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PackingList": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"autoBill": {
"type": "boolean",
"readOnly": true
},
"certificatePrinted": {
"type": "boolean",
"readOnly": true
},
"CODAmount": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"CODAmountPrepaid": {
"type": "boolean",
"readOnly": true
},
"CODFee": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"CODFeePrepaid": {
"type": "boolean",
"readOnly": true
},
"containerOption": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"containerUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"containerWeight": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"country": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"descriptionOfContents": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"exported": {
"type": "boolean",
"readOnly": true
},
"exportedToEDI": {
"type": "boolean",
"readOnly": true
},
"freightCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"freightChargePrepaid": {
"type": "boolean",
"readOnly": true
},
"freightTerms": {
"type": "string",
"nullable": true,
"readOnly": true
},
"freightVendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"handlingCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"isProcessed": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"isShipmentFromSystem": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"labelPrinted": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"notesToCustomer": {
"type": "string",
"nullable": true,
"readOnly": true
},
"numberOfContainers": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"packingListPrinted": {
"type": "boolean",
"readOnly": true
},
"remitAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remitCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remitCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remitStreet": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remitZIP": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shippingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"shippingStreet": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingToName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingZIP": {
"type": "string",
"nullable": true,
"readOnly": true
},
"specialInstructions": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"weightOfParts": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"PackingListLineItem": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contactName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"containerNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerPONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deliveryTicketItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isTaxable": {
"type": "boolean",
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"masterJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partWeight": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityFromStock": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityOpen": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToCancel": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToShip": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToStock": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"PackingListLineItemListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackingListLineItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"PackingListListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackingList"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProductCode": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"ARAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cashDiscount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"freightAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"salesAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"ProductCodeListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCode"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProductCodeSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/ProductCode"
}
},
"additionalProperties": false
},
"PurchaseOrder": {
"type": "object",
"properties": {
"contact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateComplete": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dateEnteredLabel": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dateRequired": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"deliveryTicketPrinted": {
"type": "boolean",
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"fax": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"GSTCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTCodeForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"ignoreMinimumOrder": {
"type": "boolean",
"readOnly": true
},
"labelPrinted": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mainDueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"notesToVendor": {
"type": "string",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"POPrinted": {
"type": "boolean",
"readOnly": true
},
"POTotal": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"POTotalForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"processFlag": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"purchasedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"RFQNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesTaxCharges": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesTaxChargesForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"salesTaxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingAddressType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingStreet": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingZip": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipToName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorQuoteNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorType": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"PurchaseOrderLineItem": {
"type": "object",
"properties": {
"certificationRequired": {
"type": "boolean",
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateFinished": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"FOB": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"gridDueDate": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isProcessed": {
"type": "boolean",
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber10": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber9": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"markupPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"miscCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscChargeForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"outsideService": {
"type": "boolean",
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchaseOrderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityCanceled": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityOrdered": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityReceived": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRejected": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired10": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRequired9": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"taxStatus": {
"type": "boolean",
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unitCost": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"unitCostForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"PurchaseOrderLineItemListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderLineItemUpdate": {
"type": "object",
"properties": {
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrder"
},
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderRelease": {
"type": "object",
"properties": {
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateReceived": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityCanceled": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantityRejected": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"receiverNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"PurchaseOrderReleaseListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderRelease"
},
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/PurchaseOrder"
}
},
"additionalProperties": false
},
"PurchaseOrderUpdate": {
"type": "object",
"properties": {
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Quote": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"city": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contactName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"country": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"fax": {
"type": "string",
"nullable": true,
"readOnly": true
},
"followUpDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"GSTCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inquiryNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isFreeFormCustomer": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"notes": {
"type": "string",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"printed": {
"type": "boolean",
"readOnly": true
},
"quotedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quoteNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipToName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"state": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"territory": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"zipCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"QuoteCreate": {
"required": [
"customerCode"
],
"type": "object",
"properties": {
"lineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuoteLineItemCreate"
},
"nullable": true
},
"address1": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"customerCode": {
"type": "string"
},
"customerName": {
"type": "string",
"nullable": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"followUpDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"inquiryNumber": {
"type": "string",
"nullable": true
},
"isFreeFormCustomer": {
"type": "boolean"
},
"location": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"quotedBy": {
"type": "string",
"nullable": true
},
"quoteNumber": {
"type": "string",
"nullable": true
},
"salesID": {
"type": "string",
"nullable": true
},
"shippingCode": {
"type": "string",
"nullable": true
},
"shipToName": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"termsCode": {
"type": "string",
"nullable": true
},
"territory": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"QuoteLineItem": {
"type": "object",
"properties": {
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"delivery": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"FOB": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isTaxable": {
"type": "boolean",
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"jobNotes": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"miscCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscChargeForeign": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"miscDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"price1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"price8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"priceForeign8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"quantity1": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity2": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity3": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity4": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity5": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity6": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity7": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantity8": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quoteNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quotePart": {
"type": "boolean",
"readOnly": true
},
"revision": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"QuoteLineItemCreate": {
"type": "object",
"properties": {
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"delivery": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"FOB": {
"type": "string",
"nullable": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobNotes": {
"type": "string",
"nullable": true
},
"jobNumber": {
"type": "string",
"nullable": true
},
"miscCharge": {
"type": "number",
"format": "double",
"nullable": true
},
"miscChargeForeign": {
"type": "number",
"format": "double",
"nullable": true
},
"miscDescription": {
"type": "string",
"nullable": true
},
"partNumber": {
"type": "string",
"nullable": true
},
"price1": {
"type": "number",
"format": "double",
"nullable": true
},
"price2": {
"type": "number",
"format": "double",
"nullable": true
},
"price3": {
"type": "number",
"format": "double",
"nullable": true
},
"price4": {
"type": "number",
"format": "double",
"nullable": true
},
"price5": {
"type": "number",
"format": "double",
"nullable": true
},
"price6": {
"type": "number",
"format": "double",
"nullable": true
},
"price7": {
"type": "number",
"format": "double",
"nullable": true
},
"price8": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign1": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign2": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign3": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign4": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign5": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign6": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign7": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign8": {
"type": "number",
"format": "double",
"nullable": true
},
"quantity1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity2": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity3": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity4": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity5": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity6": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity7": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity8": {
"type": "integer",
"format": "int32",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"uniqueID": {
"type": "integer",
"format": "int32"
},
"unit1": {
"type": "string",
"nullable": true
},
"unit2": {
"type": "string",
"nullable": true
},
"unit3": {
"type": "string",
"nullable": true
},
"unit4": {
"type": "string",
"nullable": true
},
"unit5": {
"type": "string",
"nullable": true
},
"unit6": {
"type": "string",
"nullable": true
},
"unit7": {
"type": "string",
"nullable": true
},
"unit8": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"workCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"QuoteLineItemListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuoteLineItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"QuoteLineItemSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/QuoteLineItem"
}
},
"additionalProperties": false
},
"QuoteLineItemUpdate": {
"type": "object",
"properties": {
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"delivery": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"FOB": {
"type": "string",
"nullable": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobNotes": {
"type": "string",
"nullable": true
},
"jobNumber": {
"type": "string",
"nullable": true
},
"miscCharge": {
"type": "number",
"format": "double",
"nullable": true
},
"miscChargeForeign": {
"type": "number",
"format": "double",
"nullable": true
},
"miscDescription": {
"type": "string",
"nullable": true
},
"partNumber": {
"type": "string",
"nullable": true
},
"price1": {
"type": "number",
"format": "double",
"nullable": true
},
"price2": {
"type": "number",
"format": "double",
"nullable": true
},
"price3": {
"type": "number",
"format": "double",
"nullable": true
},
"price4": {
"type": "number",
"format": "double",
"nullable": true
},
"price5": {
"type": "number",
"format": "double",
"nullable": true
},
"price6": {
"type": "number",
"format": "double",
"nullable": true
},
"price7": {
"type": "number",
"format": "double",
"nullable": true
},
"price8": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign1": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign2": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign3": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign4": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign5": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign6": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign7": {
"type": "number",
"format": "double",
"nullable": true
},
"priceForeign8": {
"type": "number",
"format": "double",
"nullable": true
},
"quantity1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity2": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity3": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity4": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity5": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity6": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity7": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity8": {
"type": "integer",
"format": "int32",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"uniqueID": {
"type": "integer",
"format": "int32"
},
"unit1": {
"type": "string",
"nullable": true
},
"unit2": {
"type": "string",
"nullable": true
},
"unit3": {
"type": "string",
"nullable": true
},
"unit4": {
"type": "string",
"nullable": true
},
"unit5": {
"type": "string",
"nullable": true
},
"unit6": {
"type": "string",
"nullable": true
},
"unit7": {
"type": "string",
"nullable": true
},
"unit8": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"workCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"QuoteListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Quote"
},
"nullable": true
}
},
"additionalProperties": false
},
"QuoteSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Quote"
}
},
"additionalProperties": false
},
"QuoteUpdate": {
"type": "object",
"properties": {
"lineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuoteLineItemUpdate"
},
"nullable": true
},
"address1": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"customerCode": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"followUpDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"inquiryNumber": {
"type": "string",
"nullable": true
},
"isFreeFormCustomer": {
"type": "boolean"
},
"location": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"quotedBy": {
"type": "string",
"nullable": true
},
"salesID": {
"type": "string",
"nullable": true
},
"shippingCode": {
"type": "string",
"nullable": true
},
"shipToName": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"termsCode": {
"type": "string",
"nullable": true
},
"territory": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ReasonCode": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"createRMA": {
"type": "boolean",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reasonCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reasonCodeID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ReasonCodeListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReasonCode"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReasonCodeSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/ReasonCode"
}
},
"additionalProperties": false
},
"Release": {
"type": "object",
"properties": {
"binLocation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateComplete": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"deliveryTicketNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deliveryType": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"destinationJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"EDISoftItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"itemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lotNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"manufacturingJobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"ReleaseCreate": {
"required": [
"quantity"
],
"type": "object",
"properties": {
"binLocation": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"deliveryType": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"EDISoftItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastModUser": {
"type": "string",
"nullable": true
},
"lotNumber": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ReleaseListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Release"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReleaseSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Release"
}
},
"additionalProperties": false
},
"Routing": {
"type": "object",
"properties": {
"actualPiecesGood": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"actualPiecesScrapped": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"burdenRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cost8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cyclePrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"estimQuantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"GLAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ignoreVendorMinimum": {
"type": "boolean",
"readOnly": true
},
"isCertificationRequired": {
"type": "boolean",
"readOnly": true
},
"isUnattendedOperation": {
"type": "boolean",
"readOnly": true
},
"laborAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"laborRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"machineRun": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"markupPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"numberMachineForJob": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"operatorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"percentEfficient": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"scrapPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupPrice": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"teamSize": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"timeUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"total": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unit8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCenter": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workOrVendor": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"RoutingCreate": {
"required": [
"cycleUnit",
"stepNumber",
"timeUnit",
"workOrVendor"
],
"type": "object",
"properties": {
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true
},
"cycleUnit": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"operatorCode": {
"type": "string",
"nullable": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32"
},
"timeUnit": {
"type": "string"
},
"vendorCode": {
"type": "string",
"nullable": true
},
"workCenter": {
"type": "string",
"nullable": true
},
"workOrVendor": {
"type": "string"
}
},
"additionalProperties": false
},
"RoutingListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Routing"
},
"nullable": true
}
},
"additionalProperties": false
},
"RoutingSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Routing"
}
},
"additionalProperties": false
},
"Salesperson": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"address1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"city": {
"type": "string",
"nullable": true,
"readOnly": true
},
"commissionAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"country": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"salesID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"state": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"YTDCommission": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"YTDSales": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"zipCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SalespersonListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Salesperson"
},
"nullable": true
}
},
"additionalProperties": false
},
"SalespersonUpdate": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"address1": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"commissionAccount": {
"type": "string",
"nullable": true
},
"commissionPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ShippingAddress": {
"type": "object",
"properties": {
"customerCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"FOB": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"nullable": true,
"readOnly": true
},
"printCertification": {
"type": "boolean",
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"shippingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingContact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingFAX": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingPhone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingState": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingZipCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipToName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"territory": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"ShippingAddressCreate": {
"required": [
"customerCode",
"location"
],
"type": "object",
"properties": {
"customerCode": {
"type": "string"
},
"location": {
"type": "string"
},
"printCertification": {
"type": "boolean"
},
"shippingAddress1": {
"type": "string",
"nullable": true
},
"shippingCity": {
"type": "string",
"nullable": true
},
"shippingCode": {
"type": "string",
"nullable": true
},
"shippingContact": {
"type": "string",
"nullable": true
},
"shippingCountry": {
"type": "string",
"nullable": true
},
"shippingFAX": {
"type": "string",
"nullable": true
},
"shippingPhone": {
"type": "string",
"nullable": true
},
"shippingState": {
"type": "string",
"nullable": true
},
"shippingZipCode": {
"type": "string",
"nullable": true
},
"shipToName": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"territory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ShippingAddressListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingAddress"
},
"nullable": true
}
},
"additionalProperties": false
},
"ShippingAddressSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/ShippingAddress"
}
},
"additionalProperties": false
},
"ShippingAddressUpdate": {
"type": "object",
"properties": {
"location": {
"type": "string",
"nullable": true
},
"printCertification": {
"type": "boolean"
},
"shippingAddress1": {
"type": "string",
"nullable": true
},
"shippingCity": {
"type": "string",
"nullable": true
},
"shippingContact": {
"type": "string",
"nullable": true
},
"shippingCountry": {
"type": "string",
"nullable": true
},
"shippingFAX": {
"type": "string",
"nullable": true
},
"shippingPhone": {
"type": "string",
"nullable": true
},
"shippingState": {
"type": "string",
"nullable": true
},
"shippingZipCode": {
"type": "string",
"nullable": true
},
"shipToName": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"territory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"StockToJobBinCreate": {
"required": [
"qty2Use"
],
"type": "object",
"properties": {
"binLocationId": {
"type": "integer",
"format": "int32"
},
"binLocation": {
"type": "string",
"nullable": true
},
"qty2Use": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"StockToJobMaterialCreate": {
"required": [
"bins",
"partNumber",
"quantityToMake"
],
"type": "object",
"properties": {
"partNumber": {
"type": "string"
},
"quantityToMake": {
"type": "number",
"format": "double"
},
"stepNo": {
"type": "number",
"format": "double",
"nullable": true
},
"bins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockToJobBinCreate"
}
}
},
"additionalProperties": false
},
"StockToJobMaterialResultSchema": {
"type": "object",
"properties": {
"partNumber": {
"type": "string",
"nullable": true
},
"quantityRequested": {
"type": "number",
"format": "double"
},
"quantityTransferred": {
"type": "number",
"format": "double"
},
"quantityCapped": {
"type": "number",
"format": "double"
},
"quantityRemainingToBuy": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"StockToJobTransferCreate": {
"required": [
"jobNumber",
"materials",
"postingEffectiveDate"
],
"type": "object",
"properties": {
"jobNumber": {
"type": "string"
},
"postingEffectiveDate": {
"type": "string"
},
"allowClosedJobs": {
"type": "boolean"
},
"materials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockToJobMaterialCreate"
}
}
},
"additionalProperties": false
},
"StockToJobTransferResult": {
"type": "object",
"properties": {
"jobNumber": {
"type": "string",
"nullable": true
},
"materials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockToJobMaterialResultSchema"
},
"nullable": true
},
"warnings": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"StockToJobTransferResultSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/StockToJobTransferResult"
}
},
"additionalProperties": false
},
"TaxCode": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active": {
"type": "boolean",
"readOnly": true
},
"allAreTaxable": {
"type": "boolean",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount10": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount5": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount6": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount7": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount8": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxAccount9": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"taxFactor": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"taxGLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"TaxCodeListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCode"
},
"nullable": true
}
},
"additionalProperties": false
},
"TaxCodeSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/TaxCode"
}
},
"additionalProperties": false
},
"Term": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"discountDays": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"latePercent": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"method": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"netDueDays": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"TermListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Term"
},
"nullable": true
}
},
"additionalProperties": false
},
"TermSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Term"
}
},
"additionalProperties": false
},
"TimeAndAttendance": {
"type": "object",
"properties": {
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"isExported": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"searchDate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ticketDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"TimeAndAttendanceDetail": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"actualClockInDate": {
"type": "string",
"nullable": true,
"readOnly": true
},
"actualClockInTime": {
"type": "string",
"nullable": true,
"readOnly": true
},
"actualClockOutDate": {
"type": "string",
"nullable": true,
"readOnly": true
},
"actualClockOutTime": {
"type": "string",
"nullable": true,
"readOnly": true
},
"adjustedClockInDate": {
"type": "string",
"nullable": true,
"readOnly": true
},
"adjustedClockInTime": {
"type": "string",
"nullable": true,
"readOnly": true
},
"adjustedClockOutDate": {
"type": "string",
"nullable": true,
"readOnly": true
},
"adjustedClockOutTime": {
"type": "string",
"nullable": true,
"readOnly": true
},
"attendanceCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"clockOutDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createdBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deviceNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GLCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isHoliday": {
"type": "boolean",
"readOnly": true
},
"isOvertime": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"OTCalcFlag": {
"type": "string",
"nullable": true,
"readOnly": true
},
"payRateCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"payRollRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"searchDate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ticketDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"totalActualTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"totalAdjustedTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"TimeAndAttendanceDetailCreate": {
"type": "object",
"properties": {
"actualClockInTime": {
"type": "string",
"nullable": true
},
"actualClockOutTime": {
"type": "string",
"nullable": true
},
"adjustedClockInTime": {
"type": "string",
"nullable": true
},
"adjustedClockOutTime": {
"type": "string",
"nullable": true
},
"attendanceCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"clockOutDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"GLCode": {
"type": "string",
"nullable": true
},
"isHoliday": {
"type": "boolean"
},
"isOvertime": {
"type": "boolean"
},
"payRateCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TimeAndAttendanceDetailListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeAndAttendanceDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"TimeAndAttendanceDetailUpdate": {
"type": "object",
"properties": {
"actualClockInTime": {
"type": "string",
"nullable": true
},
"actualClockOutTime": {
"type": "string",
"nullable": true
},
"adjustedClockInTime": {
"type": "string",
"nullable": true
},
"adjustedClockOutTime": {
"type": "string",
"nullable": true
},
"attendanceCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"clockOutDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"GLCode": {
"type": "string",
"nullable": true
},
"isHoliday": {
"type": "boolean"
},
"isOvertime": {
"type": "boolean"
},
"payRateCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TimeAndAttendanceListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeAndAttendance"
},
"nullable": true
}
},
"additionalProperties": false
},
"TimeAndAttendanceSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/TimeAndAttendance"
}
},
"additionalProperties": false
},
"TimeTicket": {
"type": "object",
"properties": {
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"searchDate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ticketDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"TimeTicketCreate": {
"required": [
"employeeCode",
"ticketDate"
],
"type": "object",
"properties": {
"timeTicketDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeTicketTimeTicketDetailsCreate"
},
"nullable": true
},
"allowClosedJobs": {
"type": "boolean"
},
"employeeCode": {
"type": "integer",
"format": "int32"
},
"ticketDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TimeTicketDetail": {
"type": "object",
"properties": {
"actualPayRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"adjustedPayRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"allowClosedJobs": {
"type": "boolean",
"readOnly": true
},
"attendanceDetailID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"attendanceHeaderID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"burdenRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createdBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"customerRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cycleRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"deviceNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"employeeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isMaterialAllocated": {
"type": "boolean",
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"logoffTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"machineHours": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"machinesRun": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"manHours": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"nextWorkCenter": {
"type": "string",
"nullable": true,
"readOnly": true
},
"numberMachinesForJob": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"onlineID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"operationNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"overTime": {
"type": "boolean",
"readOnly": true
},
"payrollRate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"piecesFinished": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"piecesScrapped": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"posted": {
"type": "boolean",
"readOnly": true
},
"reasonNumber": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"searchDate": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"setupRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ticketDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"timeEnd": {
"type": "string",
"nullable": true,
"readOnly": true
},
"timeStart": {
"type": "string",
"nullable": true,
"readOnly": true
},
"timeTicketGUID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unattendedOperation": {
"type": "boolean",
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"TimeTicketDetailCreate": {
"required": [
"employeeCode",
"jobNumber",
"ticketDate"
],
"type": "object",
"properties": {
"allowClosedJobs": {
"type": "boolean"
},
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true
},
"employeeCode": {
"type": "integer",
"format": "int32"
},
"jobNumber": {
"type": "string"
},
"machinesRun": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberMachinesForJob": {
"type": "number",
"format": "double",
"nullable": true
},
"operationNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overTime": {
"type": "boolean"
},
"payrollRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"piecesFinished": {
"type": "number",
"format": "double",
"nullable": true
},
"piecesScrapped": {
"type": "number",
"format": "double",
"nullable": true
},
"reasonNumber": {
"type": "number",
"format": "float",
"nullable": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ticketDate": {
"type": "string",
"format": "date-time"
},
"timeEnd": {
"type": "string",
"nullable": true
},
"timeStart": {
"type": "string",
"nullable": true
},
"unattendedOperation": {
"type": "boolean"
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TimeTicketDetailListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeTicketDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"TimeTicketDetailSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/TimeTicketDetail"
}
},
"additionalProperties": false
},
"TimeTicketDetailUpdate": {
"type": "object",
"properties": {
"allowClosedJobs": {
"type": "boolean"
},
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true
},
"jobNumber": {
"type": "string",
"nullable": true
},
"machinesRun": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberMachinesForJob": {
"type": "number",
"format": "double",
"nullable": true
},
"operationNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overTime": {
"type": "boolean"
},
"payrollRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"piecesFinished": {
"type": "number",
"format": "double",
"nullable": true
},
"piecesScrapped": {
"type": "number",
"format": "double",
"nullable": true
},
"reasonNumber": {
"type": "number",
"format": "float",
"nullable": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeEnd": {
"type": "string",
"nullable": true
},
"timeStart": {
"type": "string",
"nullable": true
},
"unattendedOperation": {
"type": "boolean"
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TimeTicketListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeTicket"
},
"nullable": true
}
},
"additionalProperties": false
},
"TimeTicketSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/TimeTicket"
}
},
"additionalProperties": false
},
"TimeTicketTimeTicketDetailsCreate": {
"required": [
"jobNumber"
],
"type": "object",
"properties": {
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true
},
"jobNumber": {
"type": "string"
},
"machinesRun": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberMachinesForJob": {
"type": "number",
"format": "double",
"nullable": true
},
"operationNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overTime": {
"type": "boolean"
},
"payrollRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"piecesFinished": {
"type": "number",
"format": "double",
"nullable": true
},
"piecesScrapped": {
"type": "number",
"format": "double",
"nullable": true
},
"reasonNumber": {
"type": "number",
"format": "float",
"nullable": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeEnd": {
"type": "string",
"nullable": true
},
"timeStart": {
"type": "string",
"nullable": true
},
"unattendedOperation": {
"type": "boolean"
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TimeTicketTimeTicketDetailsUpdate": {
"type": "object",
"properties": {
"timeTicketGUID": {
"type": "string",
"nullable": true
},
"allowClosedJobs": {
"type": "boolean"
},
"billingRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"cycleTime": {
"type": "number",
"format": "double",
"nullable": true
},
"jobNumber": {
"type": "string",
"nullable": true
},
"machinesRun": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberMachinesForJob": {
"type": "number",
"format": "double",
"nullable": true
},
"operationNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overTime": {
"type": "boolean"
},
"payrollRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"piecesFinished": {
"type": "number",
"format": "double",
"nullable": true
},
"piecesScrapped": {
"type": "number",
"format": "double",
"nullable": true
},
"reasonNumber": {
"type": "number",
"format": "float",
"nullable": true
},
"setupTime": {
"type": "number",
"format": "double",
"nullable": true
},
"shift": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeEnd": {
"type": "string",
"nullable": true
},
"timeStart": {
"type": "string",
"nullable": true
},
"unattendedOperation": {
"type": "boolean"
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TimeTicketUpdate": {
"type": "object",
"properties": {
"timeTicketDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeTicketTimeTicketDetailsUpdate"
},
"nullable": true
}
},
"additionalProperties": false
},
"ToolingMaintenance": {
"type": "object",
"properties": {
"completed": {
"type": "boolean",
"readOnly": true
},
"cost": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"toolingCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ToolingMaintenanceListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolingMaintenance"
},
"nullable": true
}
},
"additionalProperties": false
},
"UserLabel": {
"type": "object",
"properties": {
"area": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currency1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currency2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"date1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"date2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"number1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"number2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"number3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"number4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text1Default": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text2Default": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text3Default": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"text4Default": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"UserLabelListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserLabel"
},
"nullable": true
}
},
"additionalProperties": false
},
"UserTransaction": {
"type": "object",
"properties": {
"action": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"object": {
"type": "string",
"nullable": true,
"readOnly": true
},
"transactionDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"userID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"value": {
"type": "string",
"nullable": true,
"readOnly": true
},
"value2": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"UserTransactionSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/UserTransaction"
}
},
"additionalProperties": false
},
"Vendor": {
"type": "object",
"properties": {
"accountingID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active": {
"type": "boolean",
"readOnly": true
},
"ARContact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ARPhone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"averageDaysToPay": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"comments1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comments2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currencyCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateLast": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"dateOpen": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"defaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"defaultFOB": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"FAX": {
"type": "string",
"nullable": true,
"readOnly": true
},
"federalIDNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"form1099Vendor": {
"type": "boolean",
"readOnly": true
},
"GLAccount1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"GSTCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isWebUser": {
"type": "boolean",
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"markup": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"minimumOrder": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"outsideService": {
"type": "boolean",
"readOnly": true
},
"phone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"printTicket": {
"type": "boolean",
"readOnly": true
},
"purchasingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingContact": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingPhone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingState": {
"type": "string",
"nullable": true,
"readOnly": true
},
"purchasingZipCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"QBVendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remittanceAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remittanceCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remittanceCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remittanceState": {
"type": "string",
"nullable": true,
"readOnly": true
},
"remittanceZipCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"restockingPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"salesTaxCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"setupCharge": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shipCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingAddress1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCity": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingCountry": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingState": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shippingZipCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shipVia": {
"type": "string",
"nullable": true,
"readOnly": true
},
"termsCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorAccountNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorType": {
"type": "string",
"nullable": true,
"readOnly": true
},
"website": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workdayBegin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workdayEnd": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workSaturday": {
"type": "boolean",
"readOnly": true
},
"workSunday": {
"type": "boolean",
"readOnly": true
},
"YTDPurchases": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"VendorCreate": {
"required": [
"currencyCode",
"vendorCode",
"vendorName"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"comments1": {
"type": "string",
"nullable": true
},
"comments2": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string"
},
"defaultEmployeeCode": {
"type": "string",
"nullable": true
},
"FAX": {
"type": "string",
"nullable": true
},
"federalIDNumber": {
"type": "string",
"nullable": true
},
"form1099Vendor": {
"type": "boolean"
},
"GLAccount1": {
"type": "string",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"markup": {
"type": "number",
"format": "double",
"nullable": true
},
"minimumOrder": {
"type": "number",
"format": "double",
"nullable": true
},
"outsideService": {
"type": "boolean"
},
"phone": {
"type": "string",
"nullable": true
},
"purchasingAddress1": {
"type": "string",
"nullable": true
},
"purchasingCity": {
"type": "string",
"nullable": true
},
"purchasingContact": {
"type": "string",
"nullable": true
},
"purchasingCountry": {
"type": "string",
"nullable": true
},
"purchasingPhone": {
"type": "string",
"nullable": true
},
"purchasingState": {
"type": "string",
"nullable": true
},
"purchasingZipCode": {
"type": "string",
"nullable": true
},
"QBVendorCode": {
"type": "string",
"nullable": true
},
"remittanceAddress1": {
"type": "string",
"nullable": true
},
"remittanceCity": {
"type": "string",
"nullable": true
},
"remittanceCountry": {
"type": "string",
"nullable": true
},
"remittanceState": {
"type": "string",
"nullable": true
},
"remittanceZipCode": {
"type": "string",
"nullable": true
},
"restockingPercent": {
"type": "number",
"format": "float",
"nullable": true
},
"salesTaxCode": {
"type": "string",
"nullable": true
},
"setupCharge": {
"type": "number",
"format": "double",
"nullable": true
},
"shipCode": {
"type": "string",
"nullable": true
},
"shippingAddress1": {
"type": "string",
"nullable": true
},
"shippingCity": {
"type": "string",
"nullable": true
},
"shippingCountry": {
"type": "string",
"nullable": true
},
"shippingState": {
"type": "string",
"nullable": true
},
"shippingZipCode": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"termsCode": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"vendorAccountNumber": {
"type": "string",
"nullable": true
},
"vendorCode": {
"type": "string"
},
"vendorName": {
"type": "string"
},
"vendorType": {
"type": "string",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"VendorListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vendor"
},
"nullable": true
}
},
"additionalProperties": false
},
"VendorReturn": {
"type": "object",
"properties": {
"billUsForReturn": {
"type": "string",
"nullable": true,
"readOnly": true
},
"comment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"correctiveActionNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCAR": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCreditMemo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createdVendorInvoiceNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createNC": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creditDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"creditedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"debitPrinted": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inspectedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inspectionDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"issuedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"labelPrinted": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"PODate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"purchasedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"QCComment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reasonForReturn": {
"type": "string",
"nullable": true,
"readOnly": true
},
"receiveDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"receivedBy": {
"type": "string",
"nullable": true,
"readOnly": true
},
"receiverNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"receivingComment": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorReturnNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorRMANumber": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"VendorReturnLineItems": {
"type": "object",
"properties": {
"correctiveActionNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createCAR": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createNC": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"nonConfNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"originalQuantityReceived": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"partDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"partNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"POItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"PONumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantityGood": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityReturned": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToCancel": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToReject": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"reasonCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"receiverItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"receiverNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"restockingPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"status": {
"type": "string",
"nullable": true,
"readOnly": true
},
"stepNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"unit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vendorReturnItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"vendorReturnNumber": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"VendorReturnLineItemsListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendorReturnLineItems"
},
"nullable": true
}
},
"additionalProperties": false
},
"VendorReturnListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendorReturn"
},
"nullable": true
}
},
"additionalProperties": false
},
"VendorReturnReleases": {
"type": "object",
"properties": {
"comments": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"POReleaseUniqueId": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToCancel": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"quantityToReject": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"releaseQuantity": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorReturnItemNumber": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"vendorReturnNumber": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"VendorReturnReleasesListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendorReturnReleases"
},
"nullable": true
}
},
"additionalProperties": false
},
"VendorSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/Vendor"
}
},
"additionalProperties": false
},
"VendorUpdate": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"comments1": {
"type": "string",
"nullable": true
},
"comments2": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"defaultEmployeeCode": {
"type": "string",
"nullable": true
},
"federalIDNumber": {
"type": "string",
"nullable": true
},
"form1099Vendor": {
"type": "boolean"
},
"GLAccount1": {
"type": "string",
"nullable": true
},
"GSTCode": {
"type": "string",
"nullable": true
},
"leadTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"markup": {
"type": "number",
"format": "double",
"nullable": true
},
"outsideService": {
"type": "boolean"
},
"purchasingAddress1": {
"type": "string",
"nullable": true
},
"purchasingCity": {
"type": "string",
"nullable": true
},
"purchasingContact": {
"type": "string",
"nullable": true
},
"purchasingCountry": {
"type": "string",
"nullable": true
},
"purchasingPhone": {
"type": "string",
"nullable": true
},
"purchasingState": {
"type": "string",
"nullable": true
},
"purchasingZipCode": {
"type": "string",
"nullable": true
},
"remittanceAddress1": {
"type": "string",
"nullable": true
},
"remittanceCity": {
"type": "string",
"nullable": true
},
"remittanceCountry": {
"type": "string",
"nullable": true
},
"remittanceState": {
"type": "string",
"nullable": true
},
"remittanceZipCode": {
"type": "string",
"nullable": true
},
"restockingPercent": {
"type": "number",
"format": "float",
"nullable": true
},
"salesTaxCode": {
"type": "string",
"nullable": true
},
"setupCharge": {
"type": "number",
"format": "double",
"nullable": true
},
"shipCode": {
"type": "string",
"nullable": true
},
"shippingAddress1": {
"type": "string",
"nullable": true
},
"shippingCity": {
"type": "string",
"nullable": true
},
"shippingCountry": {
"type": "string",
"nullable": true
},
"shippingState": {
"type": "string",
"nullable": true
},
"shippingZipCode": {
"type": "string",
"nullable": true
},
"shipVia": {
"type": "string",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"vendorAccountNumber": {
"type": "string",
"nullable": true
},
"vendorName": {
"type": "string",
"nullable": true
},
"vendorType": {
"type": "string",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"WorkCenter": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"readOnly": true
},
"attendanceCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"burdenRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"capacityFactor": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"cycle1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle10": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"cycle9": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"defaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"defaultSetupTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"defaultTimeUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"departmentNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enteredDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"hoursAvailable": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"hoursAvailableShift1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"hoursAvailableShift2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"hoursAvailableShift3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"imageRepositoryID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"laborAccount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"laborRate": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"loadingMethod": {
"type": "string",
"nullable": true,
"readOnly": true
},
"locationLeft": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"locationTop": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"operationCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"queueTime": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"queueUnit": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"runOnShift1": {
"type": "boolean",
"readOnly": true
},
"runOnShift2": {
"type": "boolean",
"readOnly": true
},
"runOnShift3": {
"type": "boolean",
"readOnly": true
},
"scheduleBegin": {
"type": "string",
"nullable": true,
"readOnly": true
},
"scheduleEnd": {
"type": "string",
"nullable": true,
"readOnly": true
},
"setup1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup10": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup5": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup6": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup7": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup8": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"setup9": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"shift2DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shift3DefaultEmployeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"shortName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"user_Memo1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true,
"readOnly": true
},
"user_Text1": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text2": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text3": {
"type": "string",
"nullable": true,
"readOnly": true
},
"user_Text4": {
"type": "string",
"nullable": true,
"readOnly": true
},
"utilizationPercent": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"workCenterImageFile": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workFriday": {
"type": "boolean",
"readOnly": true
},
"workMonday": {
"type": "boolean",
"readOnly": true
},
"workSaturday": {
"type": "boolean",
"readOnly": true
},
"workSunday": {
"type": "boolean",
"readOnly": true
},
"workThursday": {
"type": "boolean",
"readOnly": true
},
"workTuesday": {
"type": "boolean",
"readOnly": true
},
"workWednesday": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"WorkCenterCreate": {
"required": [
"shortName"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"attendanceCode": {
"type": "string",
"nullable": true
},
"burdenRate": {
"type": "number",
"format": "double",
"nullable": true
},
"capacityFactor": {
"type": "number",
"format": "float",
"nullable": true
},
"cycle1": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle10": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle2": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle3": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle4": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle5": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle6": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle7": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle8": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle9": {
"type": "number",
"format": "double",
"nullable": true
},
"departmentNumber": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"laborAccount": {
"type": "string",
"nullable": true
},
"laborRate": {
"type": "number",
"format": "double",
"nullable": true
},
"operationCode": {
"type": "string",
"nullable": true
},
"setup1": {
"type": "number",
"format": "double",
"nullable": true
},
"setup10": {
"type": "number",
"format": "double",
"nullable": true
},
"setup2": {
"type": "number",
"format": "double",
"nullable": true
},
"setup3": {
"type": "number",
"format": "double",
"nullable": true
},
"setup4": {
"type": "number",
"format": "double",
"nullable": true
},
"setup5": {
"type": "number",
"format": "double",
"nullable": true
},
"setup6": {
"type": "number",
"format": "double",
"nullable": true
},
"setup7": {
"type": "number",
"format": "double",
"nullable": true
},
"setup8": {
"type": "number",
"format": "double",
"nullable": true
},
"setup9": {
"type": "number",
"format": "double",
"nullable": true
},
"shortName": {
"type": "string"
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
},
"workCenter": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"WorkCenterListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkCenter"
},
"nullable": true
}
},
"additionalProperties": false
},
"WorkCenterMaintenance": {
"type": "object",
"properties": {
"completed": {
"type": "boolean",
"readOnly": true
},
"cost": {
"type": "number",
"format": "float",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"employeeCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"invoiceNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobNumber": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastModDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"lastModUser": {
"type": "string",
"nullable": true,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"uniqueID": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"vendorCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"wcMaintCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCenter": {
"type": "string",
"nullable": true,
"readOnly": true
},
"workCenterName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"WorkCenterMaintenanceListSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkCenterMaintenance"
},
"nullable": true
}
},
"additionalProperties": false
},
"WorkCenterSuccessResponse": {
"type": "object",
"properties": {
"Data": {
"$ref": "#/components/schemas/WorkCenter"
}
},
"additionalProperties": false
},
"WorkCenterUpdate": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"attendanceCode": {
"type": "string",
"nullable": true
},
"burdenRate": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle1": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle10": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle2": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle3": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle4": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle5": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle6": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle7": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle8": {
"type": "number",
"format": "double",
"nullable": true
},
"cycle9": {
"type": "number",
"format": "double",
"nullable": true
},
"departmentNumber": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"laborAccount": {
"type": "string",
"nullable": true
},
"laborRate": {
"type": "number",
"format": "double",
"nullable": true
},
"operationCode": {
"type": "string",
"nullable": true
},
"setup1": {
"type": "number",
"format": "double",
"nullable": true
},
"setup10": {
"type": "number",
"format": "double",
"nullable": true
},
"setup2": {
"type": "number",
"format": "double",
"nullable": true
},
"setup3": {
"type": "number",
"format": "double",
"nullable": true
},
"setup4": {
"type": "number",
"format": "double",
"nullable": true
},
"setup5": {
"type": "number",
"format": "double",
"nullable": true
},
"setup6": {
"type": "number",
"format": "double",
"nullable": true
},
"setup7": {
"type": "number",
"format": "double",
"nullable": true
},
"setup8": {
"type": "number",
"format": "double",
"nullable": true
},
"setup9": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Currency2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Date1": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Date2": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user_Memo1": {
"type": "string",
"nullable": true
},
"user_Number1": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number2": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number3": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Number4": {
"type": "number",
"format": "double",
"nullable": true
},
"user_Text1": {
"type": "string",
"nullable": true
},
"user_Text2": {
"type": "string",
"nullable": true
},
"user_Text3": {
"type": "string",
"nullable": true
},
"user_Text4": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"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"
}
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}