{ "openapi": "3.0.1", "info": { "title": "ERP API v2", "description": "Provides a common API surface for accessing ECI ERP products.\n\n\n## ERP Product Support\nThis version of the API is generally supported by:\n\n - Deacom\n - M1\n - Macola\n - JobBOSS²\n\nSupport for some resources varies, so check the *Supported ERPs* section on each resource\nto see if it's supported before using it.\n\nThe API user account used to access the ERP API determines which ERP Product, Customer, \nand any specific database (Instance) of that ERP that will be accessed. Depending on the product,\nthe actual ERP database could be a cloud hosted ERP or on premises install, therefore, performance\nof the API may vary dramatically.\n\nThe [user-info endpoint](#/Account/get_api_v1_user_info) in this API will provide basic information \nabout the user account and company being accessed, such as the companyId and product. \nIt should be noted that the **CompanyID** does not uniquely identify the instance being accessed via the API.\n\n## Authentication\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\n## Field Selection\nFor resources that support Field Selection, the `fields` parameter can be provided \nwith a comma separated list of fields to return in the result.\n\nFor example:\n\n```/api/v2/organizations?fields=name,country```\n\n\n## Filter Expressions \n\nFor resources that support filtering, filter expressions can be applied as query string parameters in\nthe format ```field_name[operator]=value```\n\nNote, for simple equality, you can omit the operator and specify fieldname=value. e.g. ```?firstName=Jane```\n\n### Operators\n\n- [eq] Equal to the given value.\n- [ne] Not Equal to the given value.\n- [gte] Greater than or equal to the given value.\n- [lte] Less than or equal to the given value.\n- [gt] Greater than the given value.\n- [lt] Less than the given value.\n- [in] Is in a list of pipe separated values.\n- [notin] Is not in a list of pipe separated values.\n\n\n## Sort Expressions\n\nFor resources that support sorting, the sort expression is specified by adding the ```sort``` query 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=-create_date\n```\n\n\n## Paging Parameters\n\nThe parameters ```take``` and ```skip``` can be provided separately but can be combined to implement server-side paging of results. \nSee the documentation for take and skip on each resource.\n\nFor example:\n```\n?take=100\n?take=100&skip=200\n```\n\n\n## Count Parameter\n\nThe parameter ```count``` may be provided to change the data retrieval behavior.\n\nThe value of `0` returns the filtered, expanded, and paginated data in the `data` property of the response. The `count` property always contains the number of records in `data`. This is the default behavior when the `count` parameter is not provided.\n\nThe value of `1` returns an empty array in the `data` property and the total count of matching source records in the `count` property, applying any requested filters but ignoring any requested paging parameters.\n\nThe value of `2` returns both the `data` records, paginated if requested, and the `count` value with the total number of records in the source, ignoring pagination.\n\n```\n0 - Data Only\n1 - Total Count Only\n2 - Data and Total Count\n```\n\n## Expansions\n\nSome data sources have relationships that can be expanded. The list of supported\nexpansions is located in the documentation for each resource below.\n\nAn expansion expression is in the form:\n\n```expand=relationship_name(fields_expression)```\n\nfields_expression is optional.\n\nFor example, to expand the timecard for a timecard line\n\n```api/v1/view/timecardlines?expand=timecard```\n\nA resulting individual record would look like:\n\n```json\n{\n \"timecardID\": 5,\n \"timecard\": {\n \"timecardID\": 5,\n \"employeeID\": \"GROSE\",\n \"shiftID\": 1,\n \"timecardDate\": \"2000-11-06T00:00:00\",\n \"uniqueID\": \"389fcb16-8740-467f-9273-9c383f1472c9\",\n \"rowVersion\": 27569\n }\n}\n```\n\nTo select only specific fields from an expansion, use an inner fields expression.\n\n```api/v1/view/timecardlines?expand=timecard(fields=uniqueid,employeeID)```\n\nAnd the resulting record would look like:\n```json\n{\n \"timecardID\": 5,\n \"timecard\": {\n \"employeeID\": \"GROSE\",\n \"uniqueID\": \"389fcb16-8740-467f-9273-9c383f1472c9\"\n }\n}\n```\n\nExpansions can also be nested.\n\n```api/v1/view/timecardlines?expand=timecard(expand=employee)```\n\n\n## ConvertToUTC\nThe time zone in which Date/Time values are represented varies by ERP\nand some times data source. Pass the ConvertToUTC parameter\nwith a value of `yes` to indicate you want supported \ndate/time field values converted to UTC. \n\n```api/v1/view/timecardlines?ConvertToUTC=yes```\n\nSee resource specific documentation for which fields are supported.\n\n## Common Attributes\n### uniqueID\n\nThe ```uniqueID``` attribute, when present, uniquely identifies a record in the source system.\nThis identifier may not be globally unique. It is only guaranteed to be unique for the same resource\nand same Company account.\n\nIn general, the ERPs use the following data types in the uniqueID field:\n\n- Macola: GUID\n- M1: GUID\n- JobBOSS²: Int32\n\n### rowVersion\n\nThe value of the rowVersion attribute is a 64bit signed integer. This value can be used to query for \nnew or modified records in most resources. New and updated records will always receive a value higher than the\nrowVersion of any other record in the source data. There may be some variations in the implementation of\nthis attribute across ERP products.\n\n## Tracing\n\nThis API supports [W3C Trace Context](https://www.w3.org/TR/trace-context/). TraceIDs will be\ngenerated for each request and returned in each response in a *traceid* header. You should\ncapture this value in any responses and consider logging it as part of any integration\nbeing built. \n\nWhen reporting problems with this API, the *traceid* in the response is the single most important piece\nof information you can provide.\n\n```\ntraceid: 00-e352fa809e1a5b47ba4d88f8182b36f4-44902b415c593c4f-00\n```\n\nIn addition, the traceid value is provided in the body of error responses.\n\n```json\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-c2857fd044158e41bf73349e95208f1e-9476acc2107e274d-00\"\n}\n```\n\nA caller can also provide their own W3C Trace Context compliant trace id\nvia the ```traceparent``` heeder in a request.\n\n```\ntraceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01\n```\n\n## Error Responses\n\nError responses will typically be in in [RFC7807](https://datatracker.ietf.org/doc/html/rfc7807) \n\"Problem details\" format as show below:\n\n### A sample 404 Not Found\n```json\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-c2857fd044158e41bf73349e95208f1e-9476acc2107e274d-00\"\n}\n```\n\n### A sample 500 Internal Server Error\n```json\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.6.1\",\n \"title\": \"An error occured while processing your request.\",\n \"status\": 500,\n \"traceId\": \"00-fd1c6ec035a01943bec2ffabf2f1d6e2-9601a3cae715e143-00\"\n}\n```\n\n## Response Headers\n\n- **traceid:** The W3C Trace Context (see above)\n- **erp-company-id**: A value identifying the ERP Company where the data in the response originated.\n- **erp-instance-id**: A value indicating the database instance being accessed. Note this value is presently not immutable, and may change periodically.\n- **cdc-request-id**: For requests that were executed via a Cognytics Data Connector request, this provides the CDC Request ID\n\n## Management Console\nUse the Integration Engine Management Console to configure and monitor access to this API.\n\n\n## Contact Information\n\nThis API is maintained by the ECI Manufacturing Integration Team.\n", "contact": { "name": "ECI Manufacturing Division Integration Team", "url": "https://www.ecisolutions.com/support/" }, "version": "3.5.585+b1e45fd230" }, "servers": [ { "url": "https://api-erp.integrations.ecimanufacturing.com:443", "description": "Production" } ], "paths": { "/api/v2/user-info": { "get": { "tags": [ "Account" ], "summary": "Gets information about the current user accessing the API.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserInfoResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserInfoResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserInfoResponse" } } } } } } }, "/api/v2/valid-values/ap-invoice-types": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of AP Invoice Type codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/valid-values/ar-invoice-types": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of AR Invoice Type codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/valid-values/delivery-types": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of Delivery Type codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/valid-values/project-statuses": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of Project Status codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/valid-values/quote-statuses": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of Quote Status codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/valid-values/organization-statuses": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of Organization Status codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/valid-values/inspection-line-source-types": { "get": { "tags": [ "ValidValues" ], "summary": "Gets the list of Inspection Line Source Type codes.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidValueSet" } } } } } } }, "/api/v2/view/ap-invoice-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of APInvoiceLine", "description": "Gets a list of APInvoiceLine.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ninvoiceID|Yes|Yes|M1\nlineID|No|Yes|M1\nitemType|No|Yes|M1\npartID|No|Yes|M1\npartRevisionID|No|Yes|M1\npartDescription|No|Yes|M1\npurchaseQuantity|No|Yes|M1\nbaseUnitCost|No|Yes|M1\nforeignUnitCost|No|Yes|M1\nbaseExtendedCost|No|Yes|M1\nforeignExtendedCost|No|Yes|M1\nbaseSetupCharge|No|Yes|M1\nforeignSetupCharge|No|Yes|M1\nunitOfMeasure|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_ap-invoice-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "invoiceID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/APInvoiceLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/APInvoiceLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/ap-invoices": { "get": { "tags": [ "View" ], "summary": "Gets a list of APInvoice", "description": "Gets a list of APInvoice.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ninvoiceID|Yes|Yes|M1, Macola\ninvoiceDate|Yes|Yes|M1, Macola\ndueDate|Yes|Yes|M1, Macola\ninvoiceType|Yes|Yes|M1, Macola\nisPostedToGL|Yes|Yes|M1, Macola\npostedDate|Yes|Yes|M1, Macola\nisOnHold|Yes|Yes|M1, Macola\nisOverpayment|No|Yes|M1, Macola\npaymentTermID|No|Yes|M1, Macola\nbaseTotal|No|Yes|M1, Macola\nforeignTotal|No|Yes|M1, Macola\nbaseBalance|No|Yes|M1, Macola\nforeignBalance|No|Yes|M1, Macola\nuniqueID|No|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\ncurrency|No|Yes|M1, Macola\nsupplierID|No|Yes|M1, Macola\npaidDate|No|Yes|M1, Macola\nplantID|No|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_ap-invoices", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "invoiceID[eq]": "abc123", "invoiceDate[gte]": "2020-09-25T00:00:00.0000000", "dueDate[gte]": "2020-09-25T00:00:00.0000000", "invoiceType[gte]": 123, "isPostedToGL[eq]": true, "postedDate[gte]": "2020-09-25T00:00:00.0000000", "isOnHold[eq]": true, "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/APInvoice" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/APInvoice" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/ar-invoices": { "get": { "tags": [ "View" ], "summary": "Gets a list of ARInvoice", "description": "Gets a list of ARInvoice.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ninvoiceID|Yes|Yes|M1, Macola\ninvoiceDate|Yes|Yes|M1, Macola\ndueDate|Yes|Yes|M1, Macola\ninvoiceType|Yes|Yes|M1, Macola\nisPostedToGL|Yes|Yes|M1, Macola\npostedDate|Yes|Yes|M1, Macola\nisOnHold|Yes|Yes|M1, Macola\nisOverpayment|Yes|Yes|M1, Macola\npaymentTermID|Yes|Yes|M1, Macola\ninvoiceTotalBase|Yes|Yes|M1, Macola\ninvoiceTotalForeign|No|Yes|M1, Macola\ninvoiceBalanceBase|No|Yes|M1, Macola\ninvoiceBalanceForeign|No|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\ncustomerID|No|Yes|M1, Macola\npaidDate|No|Yes|M1, Macola\nplantID|No|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_ar-invoices", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "invoiceID[eq]": "abc123", "invoiceDate[gte]": "2020-09-25T00:00:00.0000000", "dueDate[gte]": "2020-09-25T00:00:00.0000000", "invoiceType[gte]": 123, "isPostedToGL[eq]": true, "postedDate[gte]": "2020-09-25T00:00:00.0000000", "isOnHold[eq]": true, "isOverpayment[eq]": true, "paymentTermID[eq]": "abc123", "invoiceTotalBase[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ARInvoice" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ARInvoice" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/ar-invoice-sales-people": { "get": { "tags": [ "View" ], "summary": "Gets a list of ARInvoiceSalesPerson", "description": "Gets a list of ARInvoiceSalesPerson.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ninvoiceID|Yes|Yes|M1, Macola\nemployeeID|Yes|Yes|M1, Macola\nsequenceID|No|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_ar-invoice-sales-people", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "invoiceID[eq]": "abc123", "employeeID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ARInvoiceSalesPerson" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ARInvoiceSalesPerson" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/contacts": { "get": { "tags": [ "View" ], "summary": "Gets a list of Contact", "description": "Gets a list of Contact.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\ncontactID|Yes|Yes|M1, JobBOSS², Macola\nname|Yes|Yes|M1, JobBOSS², Macola\norganizationID|Yes|Yes|M1, JobBOSS², Macola\norganizationTypes|Yes|Yes|JobBOSS²\nphoneNumber|Yes|Yes|M1, JobBOSS², Macola\nemailAddress|Yes|Yes|M1, JobBOSS², Macola\nisActive|Yes|Yes|M1, JobBOSS², Macola\ncomments|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_contacts", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "contactID[eq]": "abc123", "name[eq]": "abc123", "organizationID[eq]": "abc123", "organizationTypes[gte]": 123, "phoneNumber[eq]": "abc123", "emailAddress[eq]": "abc123", "isActive[eq]": true, "comments[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\norganization|Organizations|The organization to which the Contact belongs.\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/cycle-codes": { "get": { "tags": [ "View" ], "summary": "Gets a list of CycleCode", "description": "Gets a list of CycleCode.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndescription|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\ncycleCodeID|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_cycle-codes", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "cycleCodeID[eq]": "abc123" } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CycleCode" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CycleCode" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/departments": { "get": { "tags": [ "View" ], "summary": "Gets a list of Department", "description": "Gets a list of Department.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndeptID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\n", "operationId": "GET__api_v2_view_departments", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "deptID[eq]": "abc123", "shortDesc[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/dmr-claim-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of DmrClaimLine", "description": "Gets a list of DmrClaimLine.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nclaimLineID|Yes|Yes|M1\npartID|Yes|Yes|M1\npartRevisionID|Yes|Yes|M1\npartShortDescription|No|Yes|M1\npartLongDescription|No|Yes|M1\npartWarehouseID|Yes|Yes|M1\nquantity|No|Yes|M1\nquantityShipped|No|Yes|M1\nunitOfMeasure|No|Yes|M1\nunitCost|No|Yes|M1\nforeignUnitCost|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\nclaimID|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_dmr-claim-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "claimLineID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partWarehouseID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "claimID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nclaim|DmrClaims|\npart|Parts|\npartRevision|PartRevisions|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmrClaimLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmrClaimLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/dmr-claims": { "get": { "tags": [ "View" ], "summary": "Gets a list of DmrClaim", "description": "Gets a list of DmrClaim.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nclaimID|Yes|Yes|M1\nsupplierOrganizationID|Yes|Yes|M1\nclaimDate|Yes|Yes|M1\nclaimTotal|No|Yes|M1\nforeignTotal|No|Yes|M1\ncurrency|No|Yes|M1\nplantID|Yes|Yes|M1\nprojectID|Yes|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\nstatus|No|Yes|M1\n", "operationId": "GET__api_v2_view_dmr-claims", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "claimID[eq]": "abc123", "supplierOrganizationID[eq]": "abc123", "claimDate[gte]": "2020-09-25T00:00:00.0000000", "plantID[eq]": "abc123", "projectID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nsupplier|Organizations|\nplant|Plants|\nproject|Projects|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmrClaim" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmrClaim" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/employees": { "get": { "tags": [ "View" ], "summary": "Gets a list of Employee", "description": "Gets a list of Employee.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nemployeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nfirstName|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlastName|Yes|Yes|M1, JobBOSS², Macola, Deacom\ntitle|Yes|Yes|M1, JobBOSS², Macola, Deacom\nsupervisorEmployeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npayRate|Yes|Yes|M1, JobBOSS², Macola, Deacom\ndeptID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nisActive|Yes|Yes|JobBOSS², Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\n", "operationId": "GET__api_v2_view_employees", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "employeeID[eq]": "abc123", "firstName[eq]": "abc123", "lastName[eq]": "abc123", "title[eq]": "abc123", "supervisorEmployeeID[eq]": "abc123", "payRate[gte]": 123, "deptID[eq]": "abc123", "shiftID[eq]": "abc123", "isActive[eq]": true, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/gl-codes": { "get": { "tags": [ "View" ], "summary": "Gets a list of GLCode", "description": "Gets a list of GLCode.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndescription|No|Yes|JobBOSS²\nglCodeID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nisActive|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_gl-codes", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "glCodeID[eq]": "abc123", "rowVersion[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "isActive[eq]": true } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GLCode" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GLCode" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/inspection-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of InspectionLine", "description": "Gets a list of InspectionLine.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nnotes|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\ninspectionID|Yes|Yes|M1\ninspectionLineID|Yes|Yes|M1\npartID|Yes|Yes|M1\npartRevisionID|Yes|Yes|M1\npartWarehouseID|Yes|Yes|M1\npartBinID|Yes|Yes|M1\nquantityToInspect|No|Yes|M1\nsupplierOrganizationID|Yes|Yes|M1\nisInspectionComplete|Yes|Yes|M1\nunitCost|No|Yes|M1\nprojectID|Yes|Yes|M1\nprojectAreaID|Yes|Yes|M1\ninspectionDate|No|Yes|M1\nsourceType|Yes|Yes|M1\ninspectorEmployeeID|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_inspection-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "inspectionID[eq]": "abc123", "inspectionLineID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partWarehouseID[eq]": "abc123", "partBinID[eq]": "abc123", "supplierOrganizationID[eq]": "abc123", "isInspectionComplete[eq]": true, "projectID[eq]": "abc123", "projectAreaID[eq]": "abc123", "sourceType[gte]": 123, "inspectorEmployeeID[eq]": "abc123" } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InspectionLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InspectionLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/job-assemblies": { "get": { "tags": [ "View" ], "summary": "Gets a list of JobAssembly", "description": "Gets a list of JobAssembly.\n\n## Supported ERPs\n - M1\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\njobID|Yes|Yes|M1, Deacom\njobAssemblyID|Yes|Yes|M1, Deacom\nlevel|No|Yes|M1, Deacom\nparentAssemblyID|No|Yes|M1, Deacom\nsourceMethodID|No|Yes|M1, Deacom\nsourceRevisionID|No|Yes|M1, Deacom\npartID|Yes|Yes|M1, Deacom\npartRevisionID|Yes|Yes|M1, Deacom\npartShortDesc|No|Yes|M1, Deacom\nquantityPerParent|No|Yes|M1, Deacom\norderQty|No|Yes|M1, Deacom\ninventoryQty|No|Yes|M1, Deacom\nscrapQty|No|Yes|M1, Deacom\nquantityToInspect|No|Yes|M1, Deacom\nquantityRcvdToInv|No|Yes|M1, Deacom\nproductionQty|No|Yes|M1, Deacom\nquantityToMake|No|Yes|M1, Deacom\nquantityToPull|No|Yes|M1, Deacom\nquantityIssued|No|Yes|M1, Deacom\nquantityCompleted|No|Yes|M1, Deacom\nisProductionComplete|No|Yes|M1, Deacom\ncompletedDate|No|Yes|M1, Deacom\nuniqueID|Yes|Yes|M1, Deacom\nrowVersion|Yes|Yes|M1, Deacom\njobIsClosed|Yes|Yes|M1, Deacom\njobClosedDate|Yes|Yes|M1, Deacom\n", "operationId": "GET__api_v2_view_job-assemblies", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "jobID[eq]": "abc123", "jobAssemblyID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "jobIsClosed[eq]": true, "jobClosedDate[gte]": "2020-09-25T04:03:00.0000000" } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobAssembly" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobAssembly" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/job-materials": { "get": { "tags": [ "View" ], "summary": "Gets a list of JobMaterial", "description": "Gets a list of JobMaterial.\n\n## Supported ERPs\n - JobBOSS²\n - M1\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\njobID|Yes|Yes|JobBOSS², M1, Deacom\njobAssemblyID|Yes|Yes|JobBOSS², M1, Deacom\njobAssemblySeq|No|Yes|M1\nmaterialPartID|Yes|Yes|JobBOSS², M1, Deacom\nmaterialPartRevisionID|Yes|Yes|JobBOSS², M1, Deacom\nestQuantity|No|Yes|JobBOSS², M1, Deacom\nestUnitCost|No|Yes|JobBOSS², M1, Deacom\nunitOfMeasure|No|Yes|JobBOSS², M1, Deacom\nleadTime|No|Yes|JobBOSS², M1, Deacom\nvendorID|Yes|Yes|JobBOSS², M1, Deacom\nuniqueID|Yes|Yes|JobBOSS², M1, Deacom\nrowVersion|Yes|Yes|JobBOSS², M1, Deacom\njobIsClosed|Yes|Yes|JobBOSS², M1, Deacom\njobClosedDate|Yes|Yes|JobBOSS², M1, Deacom\njobType|Yes|Yes|Deacom\n", "operationId": "GET__api_v2_view_job-materials", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "jobID[eq]": "abc123", "jobAssemblyID[eq]": "abc123", "materialPartID[eq]": "abc123", "materialPartRevisionID[eq]": "abc123", "vendorID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "jobIsClosed[eq]": true, "jobClosedDate[gte]": "2020-09-25T04:03:00.0000000", "jobType[eq]": "abc123" } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobMaterial" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobMaterial" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/job-operations": { "get": { "tags": [ "View" ], "summary": "Gets a list of JobOperation", "description": "Gets a list of JobOperation.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\njobID|Yes|Yes|M1, JobBOSS², Macola, Deacom\njobAssembly|Yes|Yes|M1, JobBOSS², Macola, Deacom\njobOperationSeq|Yes|Yes|M1, JobBOSS², Macola, Deacom\nstatus|Yes|Yes|M1, JobBOSS², Macola, Deacom\nworkCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nprocessID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlongDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlongDescFormatted|No|Yes|M1, JobBOSS², Macola, Deacom\noutsideOperation|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nschedStartDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nschedEndDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nactStartDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nactEndDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestSetupHours|No|Yes|M1, JobBOSS², Macola, Deacom\nestProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestQueueHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestMoveHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nactSetupHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nactualProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nactQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nvendorID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestSetupTimeValue|No|Yes|JobBOSS²\nestSetupTimeUnit|No|Yes|JobBOSS²\nestProdTimeValue|No|Yes|JobBOSS²\nestProdTimeUnit|No|Yes|JobBOSS²\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\noperationQty|No|Yes|M1, JobBOSS², Macola, Deacom\nquantityComplete|No|Yes|M1, JobBOSS², Macola, Deacom\nisSetupComplete|No|Yes|M1, JobBOSS², Macola, Deacom\nplantID|No|Yes|M1, JobBOSS², Macola, Deacom\npurchaseOrderID|No|Yes|M1, JobBOSS², Macola, Deacom\nsupplierOrganizationID|No|Yes|M1, JobBOSS², Macola, Deacom\npurchaseLocationID|No|Yes|M1, JobBOSS², Macola, Deacom\nRFQID|No|Yes|M1, JobBOSS², Macola, Deacom\ndefaultEmployeeID|Yes|Yes|JobBOSS²\ndefaultEmployeeID2|Yes|Yes|JobBOSS²\ndefaultEmployeeID3|Yes|Yes|JobBOSS²\nisUnattended|No|Yes|JobBOSS²\njobType|Yes|Yes|Deacom\nsupplierLeadTime|No|Yes|JobBOSS²\njobIsClosed|Yes|Yes|JobBOSS², M1, Deacom\njobClosedDate|Yes|Yes|JobBOSS², M1, Deacom\n", "operationId": "GET__api_v2_view_job-operations", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "jobID[eq]": "abc123", "jobAssembly[eq]": "abc123", "jobOperationSeq[gte]": 123, "status[eq]": "abc123", "workCenterID[eq]": "abc123", "processID[eq]": "abc123", "shortDesc[eq]": "abc123", "longDescText[eq]": "abc123", "outsideOperation[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "schedStartDate[gte]": "2020-09-25T04:03:00.0000000", "schedEndDate[gte]": "2020-09-25T04:03:00.0000000", "actStartDate[gte]": "2020-09-25T04:03:00.0000000", "actEndDate[gte]": "2020-09-25T04:03:00.0000000", "estProdHours[gte]": 123, "estQueueHours[gte]": 123, "estMoveHours[gte]": 123, "estQAHours[gte]": 123, "actSetupHours[gte]": 123, "actualProdHours[gte]": 123, "actQAHours[gte]": 123, "vendorID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "defaultEmployeeID[eq]": "abc123", "defaultEmployeeID2[eq]": "abc123", "defaultEmployeeID3[eq]": "abc123", "jobType[eq]": "abc123", "jobIsClosed[eq]": true, "jobClosedDate[gte]": "2020-09-25T04:03:00.0000000" } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobOperation" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobOperation" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/jobs": { "get": { "tags": [ "View" ], "summary": "Gets a list of Job", "description": "Gets a list of Job.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\njobID|Yes|Yes|M1, JobBOSS², Macola, Deacom\ncustomerID|No|Yes|M1, JobBOSS², Macola, Deacom\npartID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom\norderQty|No|Yes|M1, JobBOSS², Macola, Deacom\nprodQty|No|Yes|M1, JobBOSS², Macola, Deacom\nschedStartDate|No|Yes|M1, JobBOSS², Macola, Deacom\nschedEndDate|No|Yes|M1, JobBOSS², Macola, Deacom\nestLeadTime|No|Yes|M1, JobBOSS², Macola, Deacom\nactStartDate|No|Yes|M1, JobBOSS², Macola, Deacom\nactEndDate|No|Yes|M1, JobBOSS², Macola, Deacom\ndueDate|No|Yes|M1, JobBOSS², Macola, Deacom\nstatus|Yes|Yes|M1, JobBOSS², Macola, Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\njobCost|No|Yes|M1, JobBOSS², Macola, Deacom\njobCostForeign|No|Yes|M1, JobBOSS², Macola, Deacom\nplantID|Yes|Yes|M1, JobBOSS², Macola, Deacom\njobDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartWarehouseID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartBinID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartShortDesc|No|Yes|M1, JobBOSS², Macola, Deacom\ninventoryQty|No|Yes|M1, JobBOSS², Macola, Deacom\nisPlanningComplete|Yes|Yes|M1, JobBOSS², Macola, Deacom\nisScheduleComplete|Yes|Yes|M1, JobBOSS², Macola, Deacom\nisReleasedToFloor|Yes|Yes|M1, JobBOSS², Macola, Deacom\nisOnHold|Yes|Yes|M1, JobBOSS², Macola, Deacom\ncompletedDate|No|Yes|M1, JobBOSS², Macola, Deacom\nquantityCompleted|No|Yes|M1, JobBOSS², Macola, Deacom\nquantityShipped|No|Yes|M1, JobBOSS², Macola, Deacom\nquantityRcvdToInventory|No|Yes|M1, JobBOSS², Macola, Deacom\nprojectID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nprojectAreaID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nisClosed|Yes|Yes|M1, JobBOSS², Macola, Deacom\nclosedDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\njobPriorityID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nunitOfMeasure|No|Yes|M1, JobBOSS², Macola, Deacom\nplannerEmployeeID|No|Yes|M1, JobBOSS², Macola, Deacom\nparentJobID|Yes|Yes|JobBOSS²\nshortDesc|No|Yes|Deacom\nchildJobID|No|Yes|Deacom\njobType|Yes|Yes|Deacom\n", "operationId": "GET__api_v2_view_jobs", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "jobID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "status[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "plantID[eq]": "abc123", "jobDate[gte]": "2020-09-25T04:03:00.0000000", "partWarehouseID[eq]": "abc123", "partBinID[eq]": "abc123", "isPlanningComplete[eq]": true, "isScheduleComplete[eq]": true, "isReleasedToFloor[eq]": true, "isOnHold[eq]": true, "projectID[eq]": "abc123", "projectAreaID[eq]": "abc123", "isClosed[eq]": true, "closedDate[gte]": "2020-09-25T04:03:00.0000000", "jobPriorityID[eq]": "abc123", "parentJobID[eq]": "abc123", "jobType[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\njobOperations|JobOperations[]|\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/locations": { "get": { "tags": [ "View" ], "summary": "Gets a list of Location", "description": "Gets a list of Location.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\nlocationID|Yes|Yes|M1, JobBOSS², Macola\nname|Yes|Yes|M1, JobBOSS², Macola\norganizationID|Yes|Yes|M1, JobBOSS², Macola\norganizationTypes|Yes|Yes|JobBOSS²\naddressLine1|No|Yes|M1, JobBOSS², Macola\naddressLine2|No|Yes|M1, JobBOSS², Macola\naddressLine3|No|Yes|M1, JobBOSS², Macola\ncity|Yes|Yes|M1, JobBOSS², Macola\ncounty|Yes|Yes|M1, JobBOSS², Macola\ncountry|Yes|Yes|M1, JobBOSS², Macola\npostalCode|Yes|Yes|M1, JobBOSS², Macola\nstate|Yes|Yes|M1, JobBOSS², Macola\nisActive|Yes|Yes|M1, JobBOSS², Macola\nlocationTypes|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_locations", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "locationID[eq]": "abc123", "name[eq]": "abc123", "organizationID[eq]": "abc123", "organizationTypes[gte]": 123, "city[eq]": "abc123", "county[eq]": "abc123", "country[eq]": "abc123", "postalCode[eq]": "abc123", "state[eq]": "abc123", "isActive[eq]": true, "locationTypes[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\norganization|Organizations|The organization to which the Location belongs.\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/organization-parts": { "get": { "tags": [ "View" ], "summary": "Gets a list of OrganizationPart", "description": "Gets a list of OrganizationPart.\n\n## Supported ERPs\n - JobBOSS²\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartID|Yes|Yes|JobBOSS², M1\npartRevisionID|Yes|Yes|JobBOSS², M1\norganizationID|Yes|Yes|JobBOSS², M1\norganizationTypes|Yes|Yes|JobBOSS²\norganizationPartID|Yes|Yes|JobBOSS², M1\norganizationShortDesc|No|Yes|JobBOSS², M1\nuniqueID|Yes|Yes|JobBOSS², M1\nrowVersion|Yes|Yes|JobBOSS², M1\n", "operationId": "GET__api_v2_view_organization-parts", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "organizationID[eq]": "abc123", "organizationTypes[gte]": 123, "organizationPartID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationPart" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationPart" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/organizations": { "get": { "tags": [ "View" ], "summary": "Gets a list of Organization", "description": "Gets a list of Organization.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\nname|Yes|Yes|M1, JobBOSS², Macola\norganizationID|Yes|Yes|M1, JobBOSS², Macola\ncountry|Yes|Yes|M1, JobBOSS², Macola\nisActive|Yes|Yes|M1, JobBOSS², Macola\norganizationTypes|Yes|Yes|JobBOSS², Macola\nphoneNumber|Yes|Yes|JobBOSS²\ncustomerPaymentTermID|Yes|Yes|JobBOSS²\ncustomerTaxCodeID|Yes|Yes|JobBOSS²\nsupplierPaymentTermID|Yes|Yes|JobBOSS²\nsupplierTaxCodeID|Yes|Yes|JobBOSS²\ncurrencyCode|Yes|Yes|JobBOSS²\nwebsiteUrl|No|Yes|JobBOSS²\ncomments|No|Yes|JobBOSS²\nsalesAccountID|Yes|Yes|JobBOSS²\nleadTimeDays|No|Yes|JobBOSS²\nminimumOrderAmount|No|Yes|JobBOSS²\ncustomerStatus|Yes|Yes|M1\nsupplierStatus|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_organizations", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "name[eq]": "abc123", "organizationID[eq]": "abc123", "country[eq]": "abc123", "isActive[eq]": true, "organizationTypes[gte]": 123, "phoneNumber[eq]": "abc123", "customerPaymentTermID[eq]": "abc123", "customerTaxCodeID[eq]": "abc123", "supplierPaymentTermID[eq]": "abc123", "supplierTaxCodeID[eq]": "abc123", "currencyCode[eq]": "abc123", "salesAccountID[eq]": "abc123", "customerStatus[gte]": 123, "supplierStatus[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-bins": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartBin", "description": "Gets a list of PartBin.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartRevisionID|Yes|Yes|M1, JobBOSS², Deacom\nwarehouseID|Yes|Yes|M1, JobBOSS², Deacom\npartBinID|Yes|Yes|M1, JobBOSS², Deacom\nquantityOnHand|No|Yes|M1, JobBOSS², Deacom\nquantityAllocated|No|Yes|M1, JobBOSS², Deacom\nquantityOnOrderSales|No|Yes|M1, JobBOSS², Deacom\nquantityOnOrderPurchases|No|Yes|M1, JobBOSS², Deacom\nquantityToInspect|No|Yes|M1, JobBOSS², Deacom\nquantityToReturn|No|Yes|M1, JobBOSS², Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Deacom\npartID|Yes|Yes|M1, JobBOSS², Deacom\nlotNumber|Yes|Yes|JobBOSS²\npurchaseOrderLineID|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_part-bins", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partRevisionID[eq]": "abc123", "warehouseID[eq]": "abc123", "partBinID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "partID[eq]": "abc123", "lotNumber[eq]": "abc123", "purchaseOrderLineID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\npartRevision|PartRevisions|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartBin" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartBin" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-classes": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartClass", "description": "Gets a list of PartClass.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndescription|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\npartClassID|No|Yes|M1\nisActive|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_part-classes", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "isActive[eq]": true } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartClass" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartClass" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-cost-breaks": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartCostBreak", "description": "Gets a list of PartCostBreak.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartCostID|Yes|Yes|JobBOSS²\nquantity|No|Yes|JobBOSS²\nunitCost|No|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_part-cost-breaks", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partCostID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartCostBreak" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartCostBreak" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-costs": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartRevision", "description": "Gets a list of PartRevision.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartCostID|Yes|Yes|JobBOSS²\npartID|Yes|Yes|JobBOSS²\npartRevisionID|Yes|Yes|JobBOSS²\nstartDate|Yes|Yes|JobBOSS²\nendDate|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_part-costs", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partCostID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "startDate[gte]": "2020-09-25T04:03:00.0000000", "endDate[gte]": "2020-09-25T04:03:00.0000000", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartRevision" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartRevision" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-groups": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartGroup", "description": "Gets a list of PartGroup.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\npartGroupID|Yes|Yes|M1, JobBOSS², Macola\nparentPartGroupID|Yes|Yes|M1, JobBOSS², Macola\ndescription|No|Yes|M1, JobBOSS², Macola\nisActive|Yes|Yes|M1, JobBOSS², Macola\ninactiveDate|No|Yes|M1, JobBOSS², Macola\n", "operationId": "GET__api_v2_view_part-groups", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "partGroupID[eq]": "abc123", "parentPartGroupID[eq]": "abc123", "isActive[eq]": true } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartGroup" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartGroup" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-materials": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartMaterial", "description": "Gets a list of PartMaterial.\n\n## Supported ERPs\n - JobBOSS²\n - M1\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartID|Yes|Yes|JobBOSS², M1, Deacom\npartRevisionID|Yes|Yes|JobBOSS², M1, Deacom\npartOperationSeq|Yes|Yes|JobBOSS², M1, Deacom\nmaterialPartID|Yes|Yes|JobBOSS², M1, Deacom\nmaterialPartRevisionID|Yes|Yes|JobBOSS², M1, Deacom\nuniqueID|Yes|Yes|JobBOSS², M1, Deacom\nrowVersion|Yes|Yes|JobBOSS², M1, Deacom\nquantity|No|Yes|JobBOSS², M1, Deacom\nunitOfMeasure|No|Yes|JobBOSS², M1, Deacom\npartAssemblyID|No|Yes|M1\npartAssemblySeq|No|Yes|M1\n", "operationId": "GET__api_v2_view_part-materials", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partOperationSeq[gte]": 123, "materialPartID[eq]": "abc123", "materialPartRevisionID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterial" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterial" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-operations": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartOperation", "description": "Gets a list of PartOperation.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartOperationSeq|Yes|Yes|M1, JobBOSS², Macola, Deacom\nworkCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nprocessID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlongDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlongDescFormatted|Yes|Yes|M1, JobBOSS², Macola, Deacom\noutsideOperation|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestSetupHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestProdHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestQueueHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestMoveHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestQAHours|Yes|Yes|M1, JobBOSS², Macola, Deacom\nvendorID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nestSetupTimeValue|No|Yes|JobBOSS²\nestSetupTimeUnit|No|Yes|JobBOSS²\nestProdTimeValue|No|Yes|JobBOSS²\nestProdTimeUnit|No|Yes|JobBOSS²\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\n", "operationId": "GET__api_v2_view_part-operations", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partOperationSeq[gte]": 123, "workCenterID[eq]": "abc123", "processID[eq]": "abc123", "shortDesc[eq]": "abc123", "longDescText[eq]": "abc123", "longDescFormatted[eq]": "abc123", "outsideOperation[eq]": "abc123", "estSetupHours[gte]": 123, "estProdHours[gte]": 123, "estQueueHours[gte]": 123, "estMoveHours[gte]": 123, "estQAHours[gte]": 123, "vendorID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartOperation" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartOperation" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-price-breaks": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartPriceBreak", "description": "Gets a list of PartPriceBreak.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartPriceID|Yes|Yes|JobBOSS²\nquantity|No|Yes|JobBOSS²\nunitPrice|No|Yes|JobBOSS²\nmarkup|No|Yes|JobBOSS²\ndiscount|No|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_part-price-breaks", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partPriceID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartPriceBreak" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartPriceBreak" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-prices": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartPrice", "description": "Gets a list of PartPrice.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartPriceID|Yes|Yes|JobBOSS²\npartID|Yes|Yes|JobBOSS²\npartRevisionID|Yes|Yes|JobBOSS²\nstartDate|Yes|Yes|JobBOSS²\nendDate|Yes|Yes|JobBOSS²\nisCustomerSpecific|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_part-prices", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partPriceID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "startDate[gte]": "2020-09-25T04:03:00.0000000", "endDate[gte]": "2020-09-25T04:03:00.0000000", "isCustomerSpecific[eq]": true, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartPrice" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartPrice" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-revisions": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartRevision", "description": "Gets a list of PartRevision.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartID|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartRevisionID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlongDescText|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlongDescFormatted|Yes|Yes|M1, JobBOSS², Macola, Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\npartCost|No|Yes|M1, JobBOSS², Macola, Deacom\neffectiveStartDate|No|Yes|JobBOSS²\nexpirationEndDate|No|Yes|JobBOSS²\nsupplierOrganizationID|No|Yes|JobBOSS²\nleadTime|No|Yes|JobBOSS²\nquantityOnHand|No|Yes|JobBOSS²\npricingUnitOfMeasure|No|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_part-revisions", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "shortDesc[eq]": "abc123", "longDescText[eq]": "abc123", "longDescFormatted[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartRevision" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartRevision" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/parts": { "get": { "tags": [ "View" ], "summary": "Gets a list of Part", "description": "Gets a list of Part.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartClassID|No|Yes|M1, JobBOSS², Deacom\npartGroupID|Yes|Yes|M1, JobBOSS², Deacom\ncycleCodeID|No|Yes|M1, JobBOSS², Deacom\npartType|Yes|Yes|M1, JobBOSS², Deacom\npartID|Yes|Yes|M1, JobBOSS², Deacom\nalternatePartID|No|Yes|JobBOSS²\nuniqueID|Yes|Yes|M1, JobBOSS², Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Deacom\nisActive|Yes|Yes|M1, JobBOSS², Deacom\n", "operationId": "GET__api_v2_view_parts", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partGroupID[eq]": "abc123", "partType[gte]": 123, "partID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "isActive[eq]": true } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\npartClass|PartClasses|\npartGroup|PartGroups|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Part" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Part" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/part-transactions": { "get": { "tags": [ "View" ], "summary": "Gets a list of PartTransaction", "description": "Gets a list of PartTransaction.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\npartTransactionID|Yes|Yes|M1\npartID|Yes|Yes|M1\npartRevisionID|Yes|Yes|M1\ntransactionType|Yes|Yes|M1\nsource|Yes|Yes|M1\nreceiptType|Yes|Yes|M1\nisNonInventoryTransaction|No|Yes|M1\npurchaseOrderID|Yes|Yes|M1\njobID|Yes|Yes|M1\npartWarehouseID|Yes|Yes|M1\npartBinID|Yes|Yes|M1\nsupplierOrganizationID|Yes|Yes|M1\ninventoryQtyRcvd|No|Yes|M1\nscrapQty|No|Yes|M1\nquantityToInspect|No|Yes|M1\nquantityToReturn|No|Yes|M1\npurchaseQtyRcvd|No|Yes|M1\npurchaseUnitCost|No|Yes|M1\ntransactionDate|Yes|Yes|M1\nreference|No|Yes|M1\nshipmentID|No|Yes|M1\nshipmentLineID|No|Yes|M1\nreceiptID|No|Yes|M1\nDMRShipmentID|No|Yes|M1\nRMAReceiptID|No|Yes|M1\ninspectionID|No|Yes|M1\ninventoryCountID|No|Yes|M1\nwarehouseTransferID|No|Yes|M1\nwarehouseReceiptID|No|Yes|M1\nprojectID|No|Yes|M1\nprojectAreaID|No|Yes|M1\nplantID|No|Yes|M1\ncostType|No|Yes|M1\nquantity|No|Yes|M1\nunitLaborCost|No|Yes|M1\nunitOverheadCost|No|Yes|M1\nunitMaterialCost|No|Yes|M1\nunitSubcontractCost|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_part-transactions", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "partTransactionID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "transactionType[gte]": 123, "source[gte]": 123, "receiptType[gte]": 123, "purchaseOrderID[eq]": "abc123", "jobID[eq]": "abc123", "partWarehouseID[eq]": "abc123", "partBinID[eq]": "abc123", "supplierOrganizationID[eq]": "abc123", "transactionDate[gte]": "2020-09-25T04:03:00.0000000", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartTransaction" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartTransaction" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/payment-terms": { "get": { "tags": [ "View" ], "summary": "Gets a list of PaymentTerm", "description": "Gets a list of PaymentTerm.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndescription|No|Yes|M1, JobBOSS², Macola\npaymentTermID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\n", "operationId": "GET__api_v2_view_payment-terms", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "paymentTermID[eq]": "abc123", "rowVersion[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8" } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTerm" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTerm" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/plants": { "get": { "tags": [ "View" ], "summary": "Gets a list of Plant", "description": "Gets a list of Plant.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nplantID|Yes|Yes|M1, Macola\nname|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_plants", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "plantID[eq]": "abc123", "name[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plant" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plant" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/processes": { "get": { "tags": [ "View" ], "summary": "Gets a list of Process", "description": "Gets a list of Process.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nprocessID|Yes|Yes|M1, Macola\nshortDesc|Yes|Yes|M1, Macola\nsetupRate|Yes|Yes|M1, Macola\nproductionRate|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_processes", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "processID[eq]": "abc123", "shortDesc[eq]": "abc123", "setupRate[eq]": "abc123", "productionRate[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Process" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Process" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/production-calendars": { "get": { "tags": [ "View" ], "summary": "Gets a list of ProductionCalendar", "description": "Gets a list of ProductionCalendar.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nproductionDate|Yes|Yes|M1, Macola\nproductionHours|Yes|Yes|M1, Macola\nproductionStartTime|Yes|Yes|M1, Macola\nworkCenterID|Yes|Yes|M1, Macola\nplantID|Yes|Yes|M1, Macola\ndepartment|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_production-calendars", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "productionDate[gte]": "2020-09-25T04:03:00.0000000", "productionHours[gte]": 123, "productionStartTime[eq]": "abc123", "workCenterID[eq]": "abc123", "plantID[eq]": "abc123", "department[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionCalendar" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionCalendar" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/projects": { "get": { "tags": [ "View" ], "summary": "Gets a list of Project", "description": "Gets a list of Project.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\nprojectID|Yes|Yes|M1, Macola\ncustomerID|Yes|Yes|M1, Macola\nlocationID|No|Yes|M1, Macola\ncontactID|No|Yes|M1, Macola\ndueDate|No|Yes|M1, Macola\nprojectDate|Yes|Yes|M1, Macola\nclosedDate|No|Yes|M1, Macola\nshortDescription|No|Yes|M1, Macola\nlongDescription|No|Yes|M1, Macola\nstatusCode|No|Yes|M1, Macola\nisClosed|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_projects", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "projectID[eq]": "abc123", "customerID[eq]": "abc123", "projectDate[gte]": "2020-09-25T00:00:00.0000000", "isClosed[eq]": true } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\ncustomer|Organizations|The Customer Organization.\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/purchase-order-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of PurchaseOrderLine", "description": "Gets a list of PurchaseOrderLine.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndueDate|Yes|Yes|M1, JobBOSS², Deacom\nextendedCost|No|Yes|M1, JobBOSS², Deacom\nforeignExtendedCost|No|Yes|M1, JobBOSS², Deacom\npartID|Yes|Yes|M1, JobBOSS², Deacom\npartRevisionID|Yes|Yes|M1, JobBOSS², Deacom\npartDescription|No|Yes|M1, JobBOSS², Deacom\npartWarehouse|No|Yes|M1, JobBOSS², Deacom\npurchaseOrderLineID|Yes|Yes|M1, JobBOSS², Deacom\nquantity|No|Yes|M1, JobBOSS², Deacom\nquantityReceived|No|Yes|M1, JobBOSS², Deacom\nunitCost|No|Yes|M1, JobBOSS², Deacom\nforeignUnitCost|No|Yes|M1, JobBOSS², Deacom\nisReceived|Yes|Yes|M1, JobBOSS², Deacom\ninspectionRequired|Yes|Yes|M1, JobBOSS², Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Deacom\nisClosed|Yes|Yes|M1, JobBOSS², Deacom\npurchaseOrderID|Yes|Yes|M1, JobBOSS², Deacom\nunitOfMeasure|No|Yes|JobBOSS², Deacom\njobID|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_purchase-order-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "dueDate[gte]": "2020-09-25T00:00:00.0000000", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "purchaseOrderLineID[eq]": "abc123", "isReceived[eq]": true, "inspectionRequired[eq]": true, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "isClosed[eq]": true, "purchaseOrderID[eq]": "abc123", "jobID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\npurchaseOrder|PurchaseOrders|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/purchase-orders": { "get": { "tags": [ "View" ], "summary": "Gets a list of PurchaseOrder", "description": "Gets a list of PurchaseOrder.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\napInvoiceLocationID|No|Yes|M1, JobBOSS², Deacom\nbuyerEmployeeID|No|Yes|M1, JobBOSS², Deacom\ncurrency|No|Yes|M1, JobBOSS², Deacom\norderDate|Yes|Yes|M1, JobBOSS², Deacom\nplantID|Yes|Yes|M1, JobBOSS², Deacom\nprojectID|Yes|Yes|M1, JobBOSS², Deacom\npurchaseOrderID|Yes|Yes|M1, JobBOSS², Deacom\nsupplierOrganizationID|Yes|Yes|M1, JobBOSS², Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Deacom\nisClosed|Yes|Yes|M1, JobBOSS², Deacom\n", "operationId": "GET__api_v2_view_purchase-orders", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "orderDate[gte]": "2020-09-25T00:00:00.0000000", "plantID[eq]": "abc123", "projectID[eq]": "abc123", "purchaseOrderID[eq]": "abc123", "supplierOrganizationID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "isClosed[eq]": true } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/quote-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of QuoteLine", "description": "Gets a list of QuoteLine.\n\n## Supported ERPs\n - M1\n - Macola\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, Macola, JobBOSS²\nrowVersion|Yes|Yes|M1, Macola, JobBOSS²\nquoteID|Yes|Yes|M1, Macola, JobBOSS²\npartID|Yes|Yes|M1, Macola, JobBOSS²\npartRevisionID|Yes|Yes|M1, Macola, JobBOSS²\npartGroupID|Yes|Yes|M1, Macola, JobBOSS²\nshortDescription|No|Yes|M1, Macola, JobBOSS²\nquoteQuantityID|No|Yes|M1, Macola, JobBOSS²\nquoteLineID|Yes|Yes|M1, Macola, JobBOSS²\nresolutionReasonID|No|Yes|M1, Macola, JobBOSS²\nlocationID|No|Yes|Macola\n", "operationId": "GET__api_v2_view_quote-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "quoteID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partGroupID[eq]": "abc123", "quoteLineID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nquote|Quotes|The parent Quote header for this line.\nresolutionReason|Reasons|The reason detail for the resolution.\npartGroup|PartGroups|The parent Quote header for this line.\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/quote-quantities": { "get": { "tags": [ "View" ], "summary": "Provides a breakdown of pricing for quote line items based on any included quantity discounts.", "description": "Gets a list of QuoteQuantity.\n\n## Supported ERPs\n - M1\n - Macola\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, Macola, JobBOSS²\nrowVersion|Yes|Yes|M1, Macola, JobBOSS²\nquoteQuantityID|Yes|Yes|M1, Macola, JobBOSS²\nquoteID|Yes|Yes|M1, Macola, JobBOSS²\nquoteLineID|Yes|Yes|M1, Macola, JobBOSS²\nquantity|No|Yes|M1, Macola, JobBOSS²\nbaseUnitPrice|No|Yes|M1, Macola, JobBOSS²\nforeignUnitPrice|No|Yes|M1, Macola, JobBOSS²\n", "operationId": "GET__api_v2_view_quote-quantities", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "quoteQuantityID[eq]": "abc123", "quoteID[eq]": "abc123", "quoteLineID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nquote|Quotes|The parent Quote header for this line.\nquoteLine|QuoteLines|The relaed quote line.\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteQuantity" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteQuantity" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/quotes": { "get": { "tags": [ "View" ], "summary": "Gets a list of Quote", "description": "Gets a list of Quote.\n\n## Supported ERPs\n - M1\n - Macola\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, Macola, JobBOSS²\nrowVersion|Yes|Yes|M1, Macola, JobBOSS²\nquoteID|Yes|Yes|M1, Macola, JobBOSS²\nemployeeID|Yes|Yes|M1, Macola, JobBOSS²\norganizationID|Yes|Yes|M1, Macola, JobBOSS²\nlocationID|Yes|Yes|M1, Macola, JobBOSS²\ncontactID|No|Yes|M1, Macola, JobBOSS²\ninvoiceLocationID|No|Yes|M1, Macola, JobBOSS²\nquoteDate|Yes|Yes|M1, Macola, JobBOSS²\ndueDate|No|Yes|M1, Macola, JobBOSS²\nisClosed|Yes|Yes|M1, Macola, JobBOSS²\nclosedDate|Yes|Yes|M1, Macola, JobBOSS²\ncurrencyRateID|No|Yes|M1, Macola, JobBOSS²\ncustomerID|Yes|Yes|M1, Macola, JobBOSS²\nexpirationDate|Yes|Yes|M1, Macola, JobBOSS²\nplantID|No|Yes|M1, Macola, JobBOSS²\nprojectID|No|Yes|M1, Macola, JobBOSS²\nshipToOrganizationID|No|Yes|M1, Macola, JobBOSS²\nshipToContactID|No|Yes|M1, Macola, JobBOSS²\nshipToLocationID|No|Yes|M1, Macola, JobBOSS²\nstatusCode|No|Yes|M1, Macola, JobBOSS²\ntotalSalesAmount|No|Yes|Macola\nawardProbability|No|Yes|Macola\nlostSaleCode|No|Yes|Macola\n", "operationId": "GET__api_v2_view_quotes", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "quoteID[eq]": "abc123", "employeeID[eq]": "abc123", "organizationID[eq]": "abc123", "locationID[eq]": "abc123", "quoteDate[gte]": "2020-09-25T00:00:00.0000000", "isClosed[eq]": true, "closedDate[gte]": "2020-09-25T00:00:00.0000000", "customerID[eq]": "abc123", "expirationDate[gte]": "2020-09-25T00:00:00.0000000" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\ncustomer|Organizations|The Customer Organization.\ncontact|Contacts|The Customer Contact record.\nshipTo|Organizations|The Ship To Organization.\nshipToContact|Contacts|The Ship To Contact record.\nproject|Projects|The Project record for this quote.\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/quote-sales-people": { "get": { "tags": [ "View" ], "summary": "Gets a list of QuoteSalesPerson", "description": "Gets a list of QuoteSalesPerson.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nquoteID|Yes|Yes|M1, Macola\nemployeeID|Yes|Yes|M1, Macola\npercentage|No|Yes|M1, Macola\nisClosed|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\nsequenceNo|No|Yes|Macola\n", "operationId": "GET__api_v2_view_quote-sales-people", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "quoteID[eq]": "abc123", "employeeID[eq]": "abc123", "isClosed[eq]": true, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nquote|Quotes|The parent Quote header for this line.\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSalesPerson" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSalesPerson" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/reasons": { "get": { "tags": [ "View" ], "summary": "Gets a list of Reason", "description": "Gets a list of Reason.\n\n## Supported ERPs\n - M1\n - Macola\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nreasonID|Yes|Yes|M1, Macola, JobBOSS²\ndescription|No|Yes|M1, Macola, JobBOSS²\nname|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|M1, Macola, JobBOSS²\nrowVersion|Yes|Yes|M1, Macola, JobBOSS²\n", "operationId": "GET__api_v2_view_reasons", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "reasonID[eq]": "abc123", "name[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Reason" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Reason" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/rma-claim-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of RmaClaimLine", "description": "Gets a list of RmaClaimLine.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nunitPrice|No|Yes|M1\nforeignUnitPrice|No|Yes|M1\nextendedPrice|No|Yes|M1\nforeignExtendedPrice|No|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\nclaimID|Yes|Yes|M1\nclaimLineID|Yes|Yes|M1\nquantity|No|Yes|M1\npartID|Yes|Yes|M1\npartRevisionID|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_rma-claim-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "claimID[eq]": "abc123", "claimLineID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nclaim|RmaClaims|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RmaClaimLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RmaClaimLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/rma-claims": { "get": { "tags": [ "View" ], "summary": "Gets a list of RmaClaim", "description": "Gets a list of RmaClaim.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nclaimDate|Yes|Yes|M1\nclaimTotal|Yes|Yes|M1\nforeignTotal|Yes|Yes|M1\ncurrency|No|Yes|M1\ncustomerOrganizationID|Yes|Yes|M1\nplantID|Yes|Yes|M1\nclaimID|Yes|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\nstatus|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_rma-claims", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "claimDate[gte]": "2020-09-25T00:00:00.0000000", "claimTotal[gte]": 123, "foreignTotal[gte]": 123, "customerOrganizationID[eq]": "abc123", "plantID[eq]": "abc123", "claimID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "status[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\ncustomer|Organizations|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RmaClaim" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RmaClaim" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/rma-receipt-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of RmaReceiptLine", "description": "Gets a list of RmaReceiptLine.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndescription|No|Yes|M1\nisInspected|Yes|Yes|M1\npartID|Yes|Yes|M1\npartLongDescription|No|Yes|M1\npartRevisionID|Yes|Yes|M1\npartWarehouseID|Yes|Yes|M1\nprojectID|Yes|Yes|M1\nisReceived|Yes|Yes|M1\ninspectionRequired|Yes|Yes|M1\nclaimLineID|Yes|Yes|M1\nclaimQuantity|Yes|Yes|M1\nreceiptID|Yes|Yes|M1\nreceiptLineID|Yes|Yes|M1\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\nisClosed|Yes|Yes|M1\nisReversed|Yes|Yes|M1\nclaimID|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_rma-receipt-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "isInspected[eq]": true, "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partWarehouseID[eq]": "abc123", "projectID[eq]": "abc123", "isReceived[eq]": true, "inspectionRequired[eq]": true, "claimLineID[eq]": "abc123", "claimQuantity[gte]": 123, "receiptID[eq]": "abc123", "receiptLineID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "isClosed[eq]": true, "isReversed[eq]": true, "claimID[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nclaim|RmaClaims|\nclaimLine|RmaClaimLines|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RmaReceiptLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RmaReceiptLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/sales-accounts": { "get": { "tags": [ "View" ], "summary": "Gets a list of SalesAccount", "description": "Gets a list of SalesAccount.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nsalesAccountID|Yes|Yes|JobBOSS²\nname|Yes|Yes|JobBOSS²\nisActive|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_sales-accounts", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "salesAccountID[eq]": "abc123", "name[eq]": "abc123", "isActive[eq]": true, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesAccount" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesAccount" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/sales-order-deliveries": { "get": { "tags": [ "View" ], "summary": "Gets a list of SalesOrderDelivery", "description": "Gets a list of SalesOrderDelivery.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nsalesOrderID|Yes|Yes|M1, Macola\norderLine|Yes|Yes|M1, Macola\norderLineDelivery|Yes|Yes|M1, Macola\npromisedDate|Yes|Yes|M1, Macola\npromisedQty|Yes|Yes|M1, Macola\nshippedDate|Yes|Yes|M1, Macola\nshippedQty|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\ndeliveryTypeCode|No|Yes|M1, Macola\nsalesOrderType|No|Yes|Macola\n", "operationId": "GET__api_v2_view_sales-order-deliveries", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "salesOrderID[eq]": "abc123", "orderLine[gte]": 123, "orderLineDelivery[eq]": "abc123", "promisedDate[gte]": "2020-09-25T04:03:00.0000000", "promisedQty[gte]": 123, "shippedDate[gte]": "2020-09-25T04:03:00.0000000", "shippedQty[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nsalesOrderJobs|SalesOrderJobs[]|\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelivery" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelivery" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/sales-order-jobs": { "get": { "tags": [ "View" ], "summary": "Gets a list of SalesOrderJob", "description": "Gets a list of SalesOrderJob.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nsalesOrderID|Yes|Yes|M1, JobBOSS², Macola\norderLine|Yes|Yes|M1, JobBOSS², Macola\norderLineDelivery|Yes|Yes|M1, JobBOSS², Macola\njobID|Yes|Yes|M1, JobBOSS², Macola\norderJobSeq|Yes|Yes|M1, JobBOSS², Macola\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\n", "operationId": "GET__api_v2_view_sales-order-jobs", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "salesOrderID[eq]": "abc123", "orderLine[gte]": 123, "orderLineDelivery[eq]": "abc123", "jobID[eq]": "abc123", "orderJobSeq[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderJob" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderJob" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/sales-order-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of SalesOrderLine", "description": "Gets a list of SalesOrderLine.\n\n## Supported ERPs\n - M1\n - Macola\n - JobBOSS²\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nsalesOrderID|Yes|Yes|M1, Macola, JobBOSS², Deacom\norderLine|Yes|Yes|M1, Macola, JobBOSS², Deacom\ntotalSalePrice|Yes|Yes|M1, Macola, JobBOSS², Deacom\nuniqueID|Yes|Yes|M1, Macola, JobBOSS², Deacom\nrowVersion|Yes|Yes|M1, Macola, JobBOSS², Deacom\npartID|No|Yes|M1, Macola, JobBOSS², Deacom\npartRevisionID|No|Yes|M1, Macola, JobBOSS², Deacom\npartGroupID|No|Yes|M1, Macola, JobBOSS², Deacom\nshortDescription|No|Yes|M1, Macola, JobBOSS², Deacom\nsaleUom|No|Yes|M1, Macola, JobBOSS², Deacom\nbaseUnitPrice|No|Yes|M1, Macola, JobBOSS², Deacom\nforeignUnitPrice|No|Yes|M1, Macola, JobBOSS², Deacom\nbaseExtendedPrice|No|Yes|M1, Macola, JobBOSS², Deacom\nforeignExtendedPrice|No|Yes|M1, Macola, JobBOSS², Deacom\nquantityOrdered|No|Yes|M1, Macola, JobBOSS², Deacom\nquantityShipped|No|Yes|M1, Macola, JobBOSS², Deacom\npurchaseOrderCost|No|Yes|M1, Macola, JobBOSS², Deacom\npurchaseOrderCostForeign|No|Yes|M1, Macola, JobBOSS², Deacom\nsalesOrderType|No|Yes|Macola\nlocationID|No|Yes|Macola\nshippedDate|No|Yes|Macola\nisPosted|No|Yes|Macola\ndueDate|No|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_sales-order-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "salesOrderID[eq]": "abc123", "orderLine[gte]": 123, "totalSalePrice[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nsalesOrderDeliveries|SalesOrderDeliveries[]|\nsalesOrderJobs|SalesOrderJobs|\nsalesOrder|SalesOrders|\npartRevision|PartRevisions|\npartGroup|PartGroups|\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/sales-orders": { "get": { "tags": [ "View" ], "summary": "Gets a list of SalesOrder", "description": "Gets a list of SalesOrder.\n\n## Supported ERPs\n - M1\n - Macola\n - JobBOSS²\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1, Macola, JobBOSS², Deacom\nrowVersion|Yes|Yes|M1, Macola, JobBOSS², Deacom\nsalesOrderID|Yes|Yes|M1, Macola, JobBOSS², Deacom\ncustomerID|Yes|Yes|M1, Macola, JobBOSS², Deacom\norderDate|Yes|Yes|M1, Macola, JobBOSS², Deacom\nplantID|No|Yes|M1, Macola, JobBOSS², Deacom\nprojectID|No|Yes|M1, Macola, JobBOSS², Deacom\nsalesOrderType|No|Yes|Macola\ntotalSalesAmount|No|Yes|Macola\nstatus|No|Yes|Macola\noriginalOrderType|No|Yes|Macola\nquoteID|No|Yes|Macola\nclosedDate|Yes|Yes|Macola\n", "operationId": "GET__api_v2_view_sales-orders", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "salesOrderID[eq]": "abc123", "customerID[eq]": "abc123", "orderDate[gte]": "2020-09-25T00:00:00.0000000", "closedDate[gte]": "2020-09-25T00:00:00.0000000" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\ncustomer|Organizations|The Customer Organization record.\nplant|Plants|The Plant record.\nproject|Projects|The Project record for this Sales Order.\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/sales-order-sales-people": { "get": { "tags": [ "View" ], "summary": "Gets a list of SalesOrderSalesPerson", "description": "Gets a list of SalesOrderSalesPerson.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nsalesOrderID|Yes|Yes|M1, Macola\nsalesEmployeeID|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nisActive|Yes|Yes|M1, Macola\nsequenceNo|No|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\nsalesOrderType|No|Yes|Macola\npercentage|No|Yes|Macola\n", "operationId": "GET__api_v2_view_sales-order-sales-people", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "salesOrderID[eq]": "abc123", "salesEmployeeID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "isActive[eq]": true, "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nsalesOrder|SalesOrders|\nsalesEmployee|Employees|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderSalesPerson" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderSalesPerson" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/shift-days": { "get": { "tags": [ "View" ], "summary": "Gets a list of ShiftDay", "description": "Gets a list of ShiftDay.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nshiftID|Yes|Yes|M1, Macola\nshiftDay|Yes|Yes|M1, Macola\nstartTime|Yes|Yes|M1, Macola\nendTime|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_shift-days", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "shiftID[eq]": "abc123", "shiftDay[eq]": "abc123", "startTime[eq]": "abc123", "endTime[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftDay" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftDay" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/shifts": { "get": { "tags": [ "View" ], "summary": "Gets a list of Shift", "description": "Gets a list of Shift.\n\n## Supported ERPs\n - M1\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nshiftID|Yes|Yes|M1, Macola\nshortDesc|Yes|Yes|M1, Macola\ninactiveDate|Yes|Yes|M1, Macola\nuniqueID|Yes|Yes|M1, Macola\nrowVersion|Yes|Yes|M1, Macola\n", "operationId": "GET__api_v2_view_shifts", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "shiftID[eq]": "abc123", "shortDesc[eq]": "abc123", "inactiveDate[gte]": "2020-09-25T04:03:00.0000000", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nshiftDays|ShiftDays[]|\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Shift" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Shift" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/shipment-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of ShipmentLine", "description": "Gets a list of ShipmentLine.\n\n## Supported ERPs\n - M1\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nuniqueID|Yes|Yes|M1\nrowVersion|Yes|Yes|M1\nshipmentID|Yes|Yes|M1\nshipmentLineID|Yes|Yes|M1\npartID|Yes|Yes|M1\npartRevisionID|Yes|Yes|M1\ndescription|No|Yes|M1\npartWarehouseID|Yes|Yes|M1\npartBinID|Yes|Yes|M1\ninvQtyShipped|No|Yes|M1\njobQtyShipped|No|Yes|M1\nunitPriceForeign|No|Yes|M1\nextendedPriceForeign|No|Yes|M1\nisShippedComplete|Yes|Yes|M1\nunitOfMeasure|No|Yes|M1\nsalesOrderID|Yes|Yes|M1\nsalesOrderLineID|Yes|Yes|M1\nsalesOrderDeliveryID|Yes|Yes|M1\njobID|Yes|Yes|M1\npartGroupID|Yes|Yes|M1\nprojectID|Yes|Yes|M1\n", "operationId": "GET__api_v2_view_shipment-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "shipmentID[eq]": "abc123", "shipmentLineID[eq]": "abc123", "partID[eq]": "abc123", "partRevisionID[eq]": "abc123", "partWarehouseID[eq]": "abc123", "partBinID[eq]": "abc123", "isShippedComplete[eq]": true, "salesOrderID[eq]": "abc123", "salesOrderLineID[eq]": "abc123", "salesOrderDeliveryID[eq]": "abc123", "jobID[eq]": "abc123", "partGroupID[eq]": "abc123", "projectID[eq]": "abc123" } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/tax-codes": { "get": { "tags": [ "View" ], "summary": "Gets a list of TaxCode", "description": "Gets a list of TaxCode.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ndescription|No|Yes|JobBOSS²\ntaxCodeID|No|Yes|JobBOSS²\nisActive|No|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_tax-codes", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "rowVersion[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8" } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxCode" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxCode" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/timecard-lines": { "get": { "tags": [ "View" ], "summary": "Gets a list of TimecardLine", "description": "Gets a list of TimecardLine.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ntimecardID|Yes|Yes|M1, JobBOSS², Macola\ntimecardLine|Yes|Yes|M1, JobBOSS², Macola\njobID|Yes|Yes|M1, JobBOSS², Macola\njobAssembly|Yes|Yes|M1, JobBOSS², Macola\njobOperation|Yes|Yes|M1, JobBOSS², Macola\nworkCenterID|Yes|Yes|M1, JobBOSS², Macola\nprocessID|Yes|Yes|M1, JobBOSS², Macola\nstatus|Yes|Yes|M1, JobBOSS², Macola\ntimecardType|Yes|Yes|M1, JobBOSS², Macola\ngoodQty|Yes|Yes|M1, JobBOSS², Macola\nscrapQty|Yes|Yes|M1, JobBOSS², Macola\nreworkQty|Yes|Yes|M1, JobBOSS², Macola\nrejectQty|Yes|Yes|M1, JobBOSS², Macola\nstartTime|Yes|Yes|M1, JobBOSS², Macola\nendTime|Yes|Yes|M1, JobBOSS², Macola\nmachineHours|Yes|Yes|M1, JobBOSS², Macola\nlaborHours|Yes|Yes|M1, JobBOSS², Macola\nemployeeID|Yes|Yes|JobBOSS²\ntimecardDate|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|M1, JobBOSS², Macola\nrowVersion|Yes|Yes|M1, JobBOSS², Macola\n", "operationId": "GET__api_v2_view_timecard-lines", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "timecardID[eq]": "abc123", "timecardLine[eq]": "abc123", "jobID[eq]": "abc123", "jobAssembly[eq]": "abc123", "jobOperation[gte]": 123, "workCenterID[eq]": "abc123", "processID[eq]": "abc123", "status[eq]": "abc123", "timecardType[eq]": "abc123", "goodQty[gte]": 123, "scrapQty[gte]": 123, "reworkQty[gte]": 123, "rejectQty[gte]": 123, "startTime[gte]": "2020-09-25T04:03:00.0000000", "endTime[gte]": "2020-09-25T04:03:00.0000000", "machineHours[gte]": 123, "laborHours[gte]": 123, "employeeID[gte]": 123, "timecardDate[gte]": "2020-09-25T04:03:00.0000000", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\nworkCenters|WorkCenters[]|This relationship is obsolete and will be removed in a future release. Use 'workCenter' instead\nworkCenter|WorkCenters|The workcenter associated with this line.\ntimecards|Timecards[]|This relationship is obsolete and will be removed in a future release. Use 'timecard' instead\ntimecard|Timecards|The timecard record associated with this line.\njobs|Jobs|This relationship is obsolete and will be removed in a future release. Use 'job' instead\njob|Jobs|The Job associated with this line.\nprocesses|Processes|This relationship is obsolete and will be removed in a future release. Use 'process' instead\nprocess|Processes|The Process associated with this line.\njobOperations|JobOperations|This relationship is obsolete and will be removed in a future release. Use 'jobOperation' instead\njobOperationx|JobOperations|The Job Operation associated with this line.\nsalesOrderDeliveries|SalesOrderDeliveries[]|\nsalesOrderJobs|SalesOrderJobs|This relationship is obsolete and will be removed in a future release. Use 'salesOrderJob' instead\nsalesOrderJob|SalesOrderJobs|The Sales Order Job associated with this line.\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimecardLine" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimecardLine" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/timecards": { "get": { "tags": [ "View" ], "summary": "Gets a list of Timecard", "description": "Gets a list of Timecard.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ntimecardID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nemployeeID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom\ntimecardDate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\n", "operationId": "GET__api_v2_view_timecards", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "timecardID[eq]": "abc123", "employeeID[eq]": "abc123", "shiftID[eq]": "abc123", "timecardDate[gte]": "2020-09-25T04:03:00.0000000", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\ntimecardlines|Timecardlines[]|\nemployees|Employees[]|\n", "schema": { "type": "string" } }, { "name": "convertToUTC", "in": "query", "description": "Convert suppported date/time values to UTC before returning the data.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Timecard" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Timecard" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/timezones": { "get": { "tags": [ "View" ], "summary": "Gets a list of TimeZone", "description": "Gets a list of TimeZone.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\ntimeZoneName|Yes|Yes|M1, JobBOSS²\nuniqueID|Yes|Yes|M1, JobBOSS²\nrowVersion|Yes|Yes|M1, JobBOSS²\n", "operationId": "GET__api_v2_view_timezones", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "timeZoneName[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123 } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZone" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZone" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/work-center-rate-breaks": { "get": { "tags": [ "View" ], "summary": "Gets a list of WorkCenterRateBreak", "description": "Gets a list of WorkCenterRateBreak.\n\n## Supported ERPs\n - JobBOSS²\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nworkCenterID|Yes|Yes|JobBOSS²\nshortDesc|Yes|Yes|JobBOSS²\nordinal|Yes|Yes|JobBOSS²\nsetupRate|Yes|Yes|JobBOSS²\nprodRate|Yes|Yes|JobBOSS²\nuniqueID|Yes|Yes|JobBOSS²\nrowVersion|Yes|Yes|JobBOSS²\nlaborRate|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_work-center-rate-breaks", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "workCenterID[eq]": "abc123", "shortDesc[eq]": "abc123", "ordinal[gte]": 123, "setupRate[gte]": 123, "prodRate[gte]": 123, "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "laborRate[eq]": "abc123" } } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkCenterRateBreak" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkCenterRateBreak" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } }, "/api/v2/view/work-centers": { "get": { "tags": [ "View" ], "summary": "Gets a list of WorkCenter", "description": "Gets a list of WorkCenter.\n\n## Supported ERPs\n - M1\n - JobBOSS²\n - Macola\n - Deacom\n## Resource Features\nFeature |Supported |Notes\n------------|------------|------------\nFilter Expressions|**Yes**| \nSort Expressions|**Yes**\nField Selection|**Yes**\nPagination|**Yes**\nUniqueID|uniqueID|\n## Features by Field\nField |Filterable |Sortable |Supported ERPs\n------------|------------|------------|------------\nworkCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshortDesc|Yes|Yes|M1, JobBOSS², Macola, Deacom\ndeptID|Yes|Yes|M1, JobBOSS², Macola, Deacom\noverHeadRate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nquoteRate|Yes|Yes|M1, JobBOSS², Macola, Deacom\nprocessID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nparentWorkCenterID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nshiftID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nuniqueID|Yes|Yes|M1, JobBOSS², Macola, Deacom\nrowVersion|Yes|Yes|M1, JobBOSS², Macola, Deacom\nlaborRate|Yes|Yes|JobBOSS²\n", "operationId": "GET__api_v2_view_work-centers", "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of fields to include in the result.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort expressions.", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Limit the number of results being returned", "schema": { "minimum": 0, "type": "integer" } }, { "name": "skip", "in": "query", "description": "The number of results to skip. Combine with 'take' to fetch records in pages", "schema": { "minimum": 0, "type": "integer" } }, { "name": "count", "in": "query", "description": "Data and count response behavior ", "schema": { "maximum": 2, "minimum": 0, "type": "integer" } }, { "name": "filters", "in": "query", "description": "See Filter Expressions for query string syntax. The Test UI and any generated code tool may expose filter parameters as a dictionary of name/value pairs, but if creating a raw HTTP request, they must be provided on the querystring as defined in the Filter Expression section.", "style": "form", "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Empty": { "description": "No filters applied" }, "Example #1": { "description": "A dictionary of name/value pairs that will be serialized as querystring parameters in the format ```name[operator]=value```", "value": { "workCenterID[eq]": "abc123", "shortDesc[eq]": "abc123", "deptID[eq]": "abc123", "overHeadRate[eq]": "abc123", "quoteRate[eq]": "abc123", "processID[eq]": "abc123", "parentWorkCenterID[eq]": "abc123", "shiftID[eq]": "abc123", "uniqueID[eq]": "cc90686b-399e-4094-b431-fa462f84b0a8", "rowVersion[gte]": 123, "laborRate[eq]": "abc123" } } } }, { "name": "expand", "in": "query", "description": "### Supported Expansions\nAn expansion expression containing a comma separater list of relationships to expand.\nName |Value |Description\n------------|------------|-----------\ndepartments|Departments[]|\nshifts|Shifts[]|\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkCenter" } }, "resultCount": { "type": "integer", "nullable": true } } } }, "text/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkCenter" } }, "resultCount": { "type": "integer", "nullable": true } } } } } } } } } }, "components": { "schemas": { "APInvoice": { "title": "APInvoice", "type": "object", "properties": { "invoiceID": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date" }, "invoiceType": { "type": "integer", "format": "int32" }, "isPostedToGL": { "type": "boolean" }, "postedDate": { "type": "string", "format": "date" }, "isOnHold": { "type": "boolean" }, "isOverpayment": { "type": "boolean" }, "paymentTermID": { "type": "string" }, "baseTotal": { "type": "number", "format": "double" }, "foreignTotal": { "type": "number", "format": "double" }, "baseBalance": { "type": "number", "format": "double" }, "foreignBalance": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "supplierID": { "type": "string" }, "paidDate": { "type": "string", "format": "date" }, "plantID": { "type": "string" } } }, "APInvoiceLine": { "title": "APInvoiceLine", "type": "object", "properties": { "invoiceID": { "type": "string" }, "lineID": { "type": "string" }, "itemType": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partDescription": { "type": "string" }, "purchaseQuantity": { "type": "number", "format": "double" }, "baseUnitCost": { "type": "number", "format": "double" }, "foreignUnitCost": { "type": "number", "format": "double" }, "baseExtendedCost": { "type": "number", "format": "double" }, "foreignExtendedCost": { "type": "number", "format": "double" }, "baseSetupCharge": { "type": "number", "format": "double" }, "foreignSetupCharge": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "ARInvoice": { "title": "ARInvoice", "type": "object", "properties": { "invoiceID": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date" }, "invoiceType": { "type": "integer", "format": "int32" }, "isPostedToGL": { "type": "boolean" }, "postedDate": { "type": "string", "format": "date" }, "isOnHold": { "type": "boolean" }, "isOverpayment": { "type": "boolean" }, "paymentTermID": { "type": "string" }, "invoiceTotalBase": { "type": "number", "format": "double" }, "invoiceTotalForeign": { "type": "number", "format": "double" }, "invoiceBalanceBase": { "type": "number", "format": "double" }, "invoiceBalanceForeign": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "customerID": { "type": "string" }, "paidDate": { "type": "string", "format": "date" }, "plantID": { "type": "string" } } }, "ARInvoiceSalesPerson": { "title": "ARInvoiceSalesPerson", "type": "object", "properties": { "invoiceID": { "type": "string" }, "employeeID": { "type": "string" }, "sequenceID": { "type": "integer", "format": "int32" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "Contact": { "title": "Contact", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "contactID": { "type": "string" }, "name": { "type": "string" }, "organizationID": { "type": "string" }, "organizationTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "phoneNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "isActive": { "type": "boolean" }, "comments": { "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" } } }, "CycleCode": { "title": "CycleCode", "type": "object", "properties": { "description": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "cycleCodeID": { "type": "string" } } }, "Department": { "title": "Department", "type": "object", "properties": { "deptID": { "type": "string" }, "shortDesc": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "DmrClaim": { "title": "DmrClaim", "type": "object", "properties": { "claimID": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "claimDate": { "type": "string", "format": "date" }, "claimTotal": { "type": "number", "format": "double" }, "foreignTotal": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "plantID": { "type": "string" }, "projectID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "supplier": { "$ref": "#/components/schemas/Organization" }, "plant": { "$ref": "#/components/schemas/Plant" }, "project": { "$ref": "#/components/schemas/Project" } } }, "DmrClaimLine": { "title": "DmrClaimLine", "type": "object", "properties": { "claimLineID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partShortDescription": { "type": "string" }, "partLongDescription": { "type": "string" }, "partWarehouseID": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantityShipped": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "unitCost": { "type": "number", "format": "double" }, "foreignUnitCost": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "claimID": { "type": "string" }, "claim": { "$ref": "#/components/schemas/DmrClaim" }, "part": { "$ref": "#/components/schemas/Part" }, "partRevision": { "$ref": "#/components/schemas/PartRevision" } } }, "Employee": { "title": "Employee", "type": "object", "properties": { "employeeID": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "supervisorEmployeeID": { "type": "string" }, "payRate": { "type": "number", "format": "double" }, "deptID": { "type": "string" }, "shiftID": { "type": "string" }, "isActive": { "type": "boolean" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "GLCode": { "title": "GLCode", "type": "object", "properties": { "description": { "type": "string" }, "glCodeID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "uniqueID": { "type": "string" }, "isActive": { "type": "boolean" } } }, "InspectionLine": { "title": "InspectionLine", "type": "object", "properties": { "notes": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "inspectionID": { "type": "string" }, "inspectionLineID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseID": { "type": "string" }, "partBinID": { "type": "string" }, "quantityToInspect": { "type": "number", "format": "double" }, "supplierOrganizationID": { "type": "string" }, "isInspectionComplete": { "type": "boolean" }, "unitCost": { "type": "number", "format": "double" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "inspectionDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "integer", "format": "int32" }, "inspectorEmployeeID": { "type": "string" } } }, "Job": { "title": "Job", "type": "object", "properties": { "jobID": { "type": "string" }, "customerID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "orderQty": { "type": "number", "format": "double" }, "prodQty": { "type": "number", "format": "double" }, "schedStartDate": { "type": "string", "format": "date-time" }, "schedEndDate": { "type": "string", "format": "date-time" }, "estLeadTime": { "type": "number", "format": "double" }, "actStartDate": { "type": "string", "format": "date-time" }, "actEndDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "jobCost": { "type": "number", "format": "double" }, "jobCostForeign": { "type": "number", "format": "double" }, "plantID": { "type": "string" }, "jobDate": { "type": "string", "format": "date-time" }, "partWarehouseID": { "type": "string" }, "partBinID": { "type": "string" }, "partShortDesc": { "type": "string" }, "inventoryQty": { "type": "number", "format": "double" }, "isPlanningComplete": { "type": "boolean" }, "isScheduleComplete": { "type": "boolean" }, "isReleasedToFloor": { "type": "boolean" }, "isOnHold": { "type": "boolean" }, "completedDate": { "type": "string", "format": "date-time" }, "quantityCompleted": { "type": "number", "format": "double" }, "quantityShipped": { "type": "number", "format": "double" }, "quantityRcvdToInventory": { "type": "number", "format": "double" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "isClosed": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date-time" }, "jobPriorityID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "plannerEmployeeID": { "type": "string" }, "parentJobID": { "type": "string" }, "shortDesc": { "type": "string" }, "childJobID": { "type": "string" }, "jobType": { "type": "string" }, "jobOperations": { "type": "array", "items": { "$ref": "#/components/schemas/JobOperation" } } } }, "JobAssembly": { "title": "JobAssembly", "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "string" }, "level": { "type": "integer" }, "parentAssemblyID": { "type": "string" }, "sourceMethodID": { "type": "string" }, "sourceRevisionID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partShortDesc": { "type": "string" }, "quantityPerParent": { "type": "number", "format": "double" }, "orderQty": { "type": "number", "format": "double" }, "inventoryQty": { "type": "number", "format": "double" }, "scrapQty": { "type": "number", "format": "double" }, "quantityToInspect": { "type": "number", "format": "double" }, "quantityRcvdToInv": { "type": "number", "format": "double" }, "productionQty": { "type": "number", "format": "double" }, "quantityToMake": { "type": "number", "format": "double" }, "quantityToPull": { "type": "number", "format": "double" }, "quantityIssued": { "type": "number", "format": "double" }, "quantityCompleted": { "type": "number", "format": "double" }, "isProductionComplete": { "type": "boolean" }, "completedDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "jobIsClosed": { "type": "boolean" }, "jobClosedDate": { "type": "string", "format": "date-time" } } }, "JobMaterial": { "title": "JobMaterial", "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "string" }, "jobAssemblySeq": { "type": "integer", "format": "int32" }, "materialPartID": { "type": "string" }, "materialPartRevisionID": { "type": "string" }, "estQuantity": { "type": "number", "format": "double" }, "estUnitCost": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "leadTime": { "type": "number", "format": "double" }, "vendorID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "jobIsClosed": { "type": "boolean" }, "jobClosedDate": { "type": "string", "format": "date-time" }, "jobType": { "type": "string" } } }, "JobOperation": { "title": "JobOperation", "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssembly": { "type": "string" }, "jobOperationSeq": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "shortDesc": { "type": "string" }, "longDescText": { "type": "string" }, "longDescFormatted": { "type": "string" }, "outsideOperation": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "schedStartDate": { "type": "string", "format": "date-time" }, "schedEndDate": { "type": "string", "format": "date-time" }, "actStartDate": { "type": "string", "format": "date-time" }, "actEndDate": { "type": "string", "format": "date-time" }, "estSetupHours": { "type": "number", "format": "double" }, "estProdHours": { "type": "number", "format": "double" }, "estQueueHours": { "type": "number", "format": "double" }, "estMoveHours": { "type": "number", "format": "double" }, "estQAHours": { "type": "number", "format": "double" }, "actSetupHours": { "type": "number", "format": "double" }, "actualProdHours": { "type": "number", "format": "double" }, "actQAHours": { "type": "number", "format": "double" }, "vendorID": { "type": "string" }, "estSetupTimeValue": { "type": "number", "format": "double" }, "estSetupTimeUnit": { "type": "string" }, "estProdTimeValue": { "type": "number", "format": "double" }, "estProdTimeUnit": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "operationQty": { "type": "number", "format": "double" }, "quantityComplete": { "type": "number", "format": "double" }, "isSetupComplete": { "type": "boolean" }, "plantID": { "type": "string" }, "purchaseOrderID": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "RFQID": { "type": "string" }, "defaultEmployeeID": { "type": "string" }, "defaultEmployeeID2": { "type": "string" }, "defaultEmployeeID3": { "type": "string" }, "isUnattended": { "type": "boolean" }, "jobType": { "type": "string" }, "supplierLeadTime": { "type": "integer", "format": "int32" }, "jobIsClosed": { "type": "boolean" }, "jobClosedDate": { "type": "string", "format": "date-time" } } }, "Location": { "title": "Location", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "locationID": { "type": "string" }, "name": { "type": "string" }, "organizationID": { "type": "string" }, "organizationTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "county": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "locationTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organization": { "$ref": "#/components/schemas/Organization" } } }, "Organization": { "title": "Organization", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "organizationID": { "type": "string" }, "country": { "type": "string" }, "isActive": { "type": "boolean" }, "organizationTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "phoneNumber": { "type": "string" }, "customerPaymentTermID": { "type": "string" }, "customerTaxCodeID": { "type": "string" }, "supplierPaymentTermID": { "type": "string" }, "supplierTaxCodeID": { "type": "string" }, "currencyCode": { "type": "string" }, "websiteUrl": { "type": "string" }, "comments": { "type": "string" }, "salesAccountID": { "type": "string" }, "leadTimeDays": { "type": "integer", "format": "int32" }, "minimumOrderAmount": { "type": "number", "format": "double" }, "customerStatus": { "type": "integer" }, "supplierStatus": { "type": "integer" } } }, "OrganizationPart": { "title": "OrganizationPart", "type": "object", "properties": { "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "organizationID": { "type": "string" }, "organizationTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationPartID": { "type": "string" }, "organizationShortDesc": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "Part": { "title": "Part", "type": "object", "properties": { "partClassID": { "type": "string" }, "partGroupID": { "type": "string" }, "cycleCodeID": { "type": "string" }, "partType": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "alternatePartID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "isActive": { "type": "boolean" }, "partClass": { "$ref": "#/components/schemas/PartClass" }, "partGroup": { "$ref": "#/components/schemas/PartGroup" } } }, "PartBin": { "title": "PartBin", "type": "object", "properties": { "partRevisionID": { "type": "string" }, "warehouseID": { "type": "string" }, "partBinID": { "type": "string" }, "quantityOnHand": { "type": "number", "format": "double" }, "quantityAllocated": { "type": "number", "format": "double" }, "quantityOnOrderSales": { "type": "number", "format": "double" }, "quantityOnOrderPurchases": { "type": "number", "format": "double" }, "quantityToInspect": { "type": "number", "format": "double" }, "quantityToReturn": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "partID": { "type": "string" }, "lotNumber": { "type": "string" }, "purchaseOrderLineID": { "type": "string" }, "partRevision": { "$ref": "#/components/schemas/PartRevision" } } }, "PartClass": { "title": "PartClass", "type": "object", "properties": { "description": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "partClassID": { "type": "string" }, "isActive": { "type": "boolean" } } }, "PartCostBreak": { "title": "PartCostBreak", "type": "object", "properties": { "partCostID": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "PartGroup": { "title": "PartGroup", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "partGroupID": { "type": "string" }, "parentPartGroupID": { "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "inactiveDate": { "type": "string", "format": "date" } } }, "PartMaterial": { "title": "PartMaterial", "type": "object", "properties": { "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partOperationSeq": { "type": "integer", "format": "int32" }, "materialPartID": { "type": "string" }, "materialPartRevisionID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "quantity": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "partAssemblyID": { "type": "string" }, "partAssemblySeq": { "type": "integer", "format": "int32" } } }, "PartOperation": { "title": "PartOperation", "type": "object", "properties": { "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partOperationSeq": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "shortDesc": { "type": "string" }, "longDescText": { "type": "string" }, "longDescFormatted": { "type": "string" }, "outsideOperation": { "type": "string" }, "estSetupHours": { "type": "number", "format": "double" }, "estProdHours": { "type": "number", "format": "double" }, "estQueueHours": { "type": "number", "format": "double" }, "estMoveHours": { "type": "number", "format": "double" }, "estQAHours": { "type": "number", "format": "double" }, "vendorID": { "type": "string" }, "estSetupTimeValue": { "type": "number", "format": "double" }, "estSetupTimeUnit": { "type": "string" }, "estProdTimeValue": { "type": "number", "format": "double" }, "estProdTimeUnit": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "PartPrice": { "title": "PartPrice", "type": "object", "properties": { "partPriceID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "isCustomerSpecific": { "type": "boolean" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "PartPriceBreak": { "title": "PartPriceBreak", "type": "object", "properties": { "partPriceID": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "markup": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "PartRevision": { "title": "PartRevision", "type": "object", "properties": { "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "shortDesc": { "type": "string" }, "longDescText": { "type": "string" }, "longDescFormatted": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "partCost": { "type": "number", "format": "double" }, "effectiveStartDate": { "type": "string", "format": "date" }, "expirationEndDate": { "type": "string", "format": "date" }, "supplierOrganizationID": { "type": "string" }, "leadTime": { "type": "integer", "format": "int32" }, "quantityOnHand": { "type": "number", "format": "double" }, "pricingUnitOfMeasure": { "type": "string" } } }, "PartTransaction": { "title": "PartTransaction", "type": "object", "properties": { "partTransactionID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "transactionType": { "type": "integer" }, "source": { "type": "integer" }, "receiptType": { "type": "integer" }, "isNonInventoryTransaction": { "type": "boolean" }, "purchaseOrderID": { "type": "string" }, "jobID": { "type": "string" }, "partWarehouseID": { "type": "string" }, "partBinID": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "inventoryQtyRcvd": { "type": "number", "format": "double" }, "scrapQty": { "type": "number", "format": "double" }, "quantityToInspect": { "type": "number", "format": "double" }, "quantityToReturn": { "type": "number", "format": "double" }, "purchaseQtyRcvd": { "type": "number", "format": "double" }, "purchaseUnitCost": { "type": "number", "format": "double" }, "transactionDate": { "type": "string", "format": "date-time" }, "reference": { "type": "string" }, "shipmentID": { "type": "string" }, "shipmentLineID": { "type": "string" }, "receiptID": { "type": "string" }, "DMRShipmentID": { "type": "string" }, "RMAReceiptID": { "type": "string" }, "inspectionID": { "type": "string" }, "inventoryCountID": { "type": "string" }, "warehouseTransferID": { "type": "string" }, "warehouseReceiptID": { "type": "string" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "plantID": { "type": "string" }, "costType": { "type": "integer" }, "quantity": { "type": "number", "format": "double" }, "unitLaborCost": { "type": "number", "format": "double" }, "unitOverheadCost": { "type": "number", "format": "double" }, "unitMaterialCost": { "type": "number", "format": "double" }, "unitSubcontractCost": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "PaymentTerm": { "title": "PaymentTerm", "type": "object", "properties": { "description": { "type": "string" }, "paymentTermID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "uniqueID": { "type": "string" } } }, "Plant": { "title": "Plant", "type": "object", "properties": { "plantID": { "type": "string" }, "name": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "Process": { "title": "Process", "type": "object", "properties": { "processID": { "type": "string" }, "shortDesc": { "type": "string" }, "setupRate": { "type": "string" }, "productionRate": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "ProductionCalendar": { "title": "ProductionCalendar", "type": "object", "properties": { "productionDate": { "type": "string", "format": "date-time" }, "productionHours": { "type": "number", "format": "double" }, "productionStartTime": { "type": "string" }, "workCenterID": { "type": "string" }, "plantID": { "type": "string" }, "department": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "Project": { "title": "Project", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "projectID": { "type": "string" }, "customerID": { "type": "string" }, "locationID": { "type": "string" }, "contactID": { "type": "string" }, "dueDate": { "type": "string", "format": "date" }, "projectDate": { "type": "string", "format": "date" }, "closedDate": { "type": "string", "format": "date" }, "shortDescription": { "type": "string" }, "longDescription": { "type": "string" }, "statusCode": { "type": "string" }, "isClosed": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/Organization" } } }, "PurchaseOrder": { "title": "PurchaseOrder", "type": "object", "properties": { "apInvoiceLocationID": { "type": "string" }, "buyerEmployeeID": { "type": "string" }, "currency": { "type": "string" }, "orderDate": { "type": "string", "format": "date" }, "plantID": { "type": "string" }, "projectID": { "type": "string" }, "purchaseOrderID": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "isClosed": { "type": "boolean" } } }, "PurchaseOrderLine": { "title": "PurchaseOrderLine", "type": "object", "properties": { "dueDate": { "type": "string", "format": "date" }, "extendedCost": { "type": "number", "format": "double" }, "foreignExtendedCost": { "type": "number", "format": "double" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partDescription": { "type": "string" }, "partWarehouse": { "type": "string" }, "purchaseOrderLineID": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantityReceived": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "foreignUnitCost": { "type": "number", "format": "double" }, "isReceived": { "type": "boolean" }, "inspectionRequired": { "type": "boolean" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "isClosed": { "type": "boolean" }, "purchaseOrderID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "jobID": { "type": "string" }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "Quote": { "title": "Quote", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "quoteID": { "type": "string" }, "employeeID": { "type": "string" }, "organizationID": { "type": "string" }, "locationID": { "type": "string" }, "contactID": { "type": "string" }, "invoiceLocationID": { "type": "string" }, "quoteDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date" }, "isClosed": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date" }, "currencyRateID": { "type": "string" }, "customerID": { "type": "string" }, "expirationDate": { "type": "string", "format": "date" }, "plantID": { "type": "string" }, "projectID": { "type": "string" }, "shipToOrganizationID": { "type": "string" }, "shipToContactID": { "type": "string" }, "shipToLocationID": { "type": "string" }, "statusCode": { "type": "string" }, "totalSalesAmount": { "type": "number", "format": "double" }, "awardProbability": { "type": "number", "format": "double" }, "lostSaleCode": { "type": "string" }, "customer": { "$ref": "#/components/schemas/Organization" }, "contact": { "$ref": "#/components/schemas/Contact" }, "shipTo": { "$ref": "#/components/schemas/Organization" }, "shipToContact": { "$ref": "#/components/schemas/Contact" }, "project": { "$ref": "#/components/schemas/Project" } } }, "QuoteLine": { "title": "QuoteLine", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "quoteID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partGroupID": { "type": "string" }, "shortDescription": { "type": "string" }, "quoteQuantityID": { "type": "string", "description": "The QuoteQuantity record identifier to be used when calculating a Quote Total." }, "quoteLineID": { "type": "string" }, "resolutionReasonID": { "type": "string" }, "locationID": { "type": "string" }, "quote": { "$ref": "#/components/schemas/Quote" }, "resolutionReason": { "$ref": "#/components/schemas/Reason" }, "partGroup": { "$ref": "#/components/schemas/PartGroup" } } }, "QuoteQuantity": { "title": "QuoteQuantity", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "quoteQuantityID": { "type": "string" }, "quoteID": { "type": "string" }, "quoteLineID": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "baseUnitPrice": { "type": "number", "description": "The price expressed in the currency of the seller.", "format": "double" }, "foreignUnitPrice": { "type": "number", "description": "The price expressed in the currency of the buyer, if different from that of the seller.", "format": "double" }, "quote": { "$ref": "#/components/schemas/Quote" }, "quoteLine": { "$ref": "#/components/schemas/QuoteLine" } } }, "QuoteSalesPerson": { "title": "QuoteSalesPerson", "type": "object", "properties": { "quoteID": { "type": "string" }, "employeeID": { "type": "string" }, "percentage": { "type": "number", "format": "double" }, "isClosed": { "type": "boolean" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "sequenceNo": { "type": "integer", "format": "int32" }, "quote": { "$ref": "#/components/schemas/Quote" } } }, "Reason": { "title": "Reason", "type": "object", "properties": { "reasonID": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "RmaClaim": { "title": "RmaClaim", "type": "object", "properties": { "claimDate": { "type": "string", "format": "date" }, "claimTotal": { "type": "number", "format": "double" }, "foreignTotal": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "customerOrganizationID": { "type": "string" }, "plantID": { "type": "string" }, "claimID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "customer": { "$ref": "#/components/schemas/Organization" } } }, "RmaClaimLine": { "title": "RmaClaimLine", "type": "object", "properties": { "unitPrice": { "type": "number", "format": "double" }, "foreignUnitPrice": { "type": "number", "format": "double" }, "extendedPrice": { "type": "number", "format": "double" }, "foreignExtendedPrice": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "claimID": { "type": "string" }, "claimLineID": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "claim": { "$ref": "#/components/schemas/RmaClaim" } } }, "RmaReceiptLine": { "title": "RmaReceiptLine", "type": "object", "properties": { "description": { "type": "string" }, "isInspected": { "type": "boolean" }, "partID": { "type": "string" }, "partLongDescription": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseID": { "type": "string" }, "projectID": { "type": "string" }, "isReceived": { "type": "boolean" }, "inspectionRequired": { "type": "boolean" }, "claimLineID": { "type": "string" }, "claimQuantity": { "type": "number", "format": "double" }, "receiptID": { "type": "string" }, "receiptLineID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "isClosed": { "type": "boolean" }, "isReversed": { "type": "boolean" }, "claimID": { "type": "string" }, "claim": { "$ref": "#/components/schemas/RmaClaim" }, "claimLine": { "$ref": "#/components/schemas/RmaClaimLine" } } }, "SalesAccount": { "title": "SalesAccount", "type": "object", "properties": { "salesAccountID": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "SalesOrder": { "title": "SalesOrder", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "salesOrderID": { "type": "string" }, "customerID": { "type": "string" }, "orderDate": { "type": "string", "format": "date" }, "plantID": { "type": "string" }, "projectID": { "type": "string" }, "salesOrderType": { "type": "string" }, "totalSalesAmount": { "type": "number", "format": "double" }, "status": { "type": "string" }, "originalOrderType": { "type": "string" }, "quoteID": { "type": "string" }, "closedDate": { "type": "string", "format": "date" }, "customer": { "$ref": "#/components/schemas/Organization" }, "plant": { "$ref": "#/components/schemas/Plant" }, "project": { "$ref": "#/components/schemas/Project" } } }, "SalesOrderDelivery": { "title": "SalesOrderDelivery", "type": "object", "properties": { "salesOrderID": { "type": "string" }, "orderLine": { "type": "integer" }, "orderLineDelivery": { "type": "string" }, "promisedDate": { "type": "string", "format": "date-time" }, "promisedQty": { "type": "number", "format": "double" }, "shippedDate": { "type": "string", "format": "date-time" }, "shippedQty": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "deliveryTypeCode": { "type": "string" }, "salesOrderType": { "type": "string" }, "salesOrderJobs": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderJob" } } } }, "SalesOrderJob": { "title": "SalesOrderJob", "type": "object", "properties": { "salesOrderID": { "type": "string" }, "orderLine": { "type": "integer" }, "orderLineDelivery": { "type": "string" }, "jobID": { "type": "string" }, "orderJobSeq": { "type": "integer", "format": "int32" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "SalesOrderLine": { "title": "SalesOrderLine", "type": "object", "properties": { "salesOrderID": { "type": "string" }, "orderLine": { "type": "integer" }, "totalSalePrice": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partGroupID": { "type": "string" }, "shortDescription": { "type": "string" }, "saleUom": { "type": "string" }, "baseUnitPrice": { "type": "number", "description": "The price expressed in the currency of the seller.", "format": "double" }, "foreignUnitPrice": { "type": "number", "description": "The price expressed in the currency of the buyer, if different from that of the seller.", "format": "double" }, "baseExtendedPrice": { "type": "number", "description": "The extended (qty x price) total expressed in the currency of the seller.", "format": "double" }, "foreignExtendedPrice": { "type": "number", "description": "The extended (qty x price) total expressed in the currency of the buyer, if different from that of the seller.", "format": "double" }, "quantityOrdered": { "type": "number", "format": "double" }, "quantityShipped": { "type": "number", "format": "double" }, "purchaseOrderCost": { "type": "number", "format": "double" }, "purchaseOrderCostForeign": { "type": "number", "format": "double" }, "salesOrderType": { "type": "string" }, "locationID": { "type": "string" }, "shippedDate": { "type": "string", "format": "date-time" }, "isPosted": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time" }, "salesOrderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelivery" } }, "salesOrderJobs": { "$ref": "#/components/schemas/SalesOrderJob" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrder" }, "partRevision": { "$ref": "#/components/schemas/PartRevision" }, "partGroup": { "$ref": "#/components/schemas/PartGroup" } } }, "SalesOrderSalesPerson": { "title": "SalesOrderSalesPerson", "type": "object", "properties": { "salesOrderID": { "type": "string" }, "salesEmployeeID": { "type": "string" }, "uniqueID": { "type": "string" }, "isActive": { "type": "boolean" }, "sequenceNo": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "integer", "format": "int64" }, "salesOrderType": { "type": "string" }, "percentage": { "type": "number", "format": "double" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrder" }, "salesEmployee": { "$ref": "#/components/schemas/Employee" } } }, "Shift": { "title": "Shift", "type": "object", "properties": { "shiftID": { "type": "number", "format": "float" }, "shortDesc": { "type": "string" }, "inactiveDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "shiftDays": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftDay" } } } }, "ShiftDay": { "title": "ShiftDay", "type": "object", "properties": { "shiftID": { "type": "number", "format": "float" }, "shiftDay": { "type": "number", "format": "float" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "ShipmentLine": { "title": "ShipmentLine", "type": "object", "properties": { "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "shipmentID": { "type": "string" }, "shipmentLineID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "description": { "type": "string" }, "partWarehouseID": { "type": "string" }, "partBinID": { "type": "string" }, "invQtyShipped": { "type": "number", "format": "double" }, "jobQtyShipped": { "type": "number", "format": "double" }, "unitPriceForeign": { "type": "number", "format": "double" }, "extendedPriceForeign": { "type": "number", "format": "double" }, "isShippedComplete": { "type": "boolean" }, "unitOfMeasure": { "type": "string" }, "salesOrderID": { "type": "string" }, "salesOrderLineID": { "type": "string" }, "salesOrderDeliveryID": { "type": "string" }, "jobID": { "type": "string" }, "partGroupID": { "type": "string" }, "projectID": { "type": "string" } } }, "TaxCode": { "title": "TaxCode", "type": "object", "properties": { "description": { "type": "string" }, "taxCodeID": { "type": "string" }, "isActive": { "type": "boolean" }, "rowVersion": { "type": "integer", "format": "int64" }, "uniqueID": { "type": "string" } } }, "TimeZone": { "title": "TimeZone", "type": "object", "properties": { "timeZoneName": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" } } }, "Timecard": { "title": "Timecard", "type": "object", "properties": { "timecardID": { "type": "string" }, "employeeID": { "type": "string" }, "shiftID": { "type": "number", "format": "float" }, "timecardDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "timecardlines": { "type": "array", "items": { "$ref": "#/components/schemas/TimecardLine" } }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } } }, "TimecardLine": { "title": "TimecardLine", "type": "object", "properties": { "timecardID": { "type": "string" }, "timecardLine": { "type": "string" }, "jobID": { "type": "string" }, "jobAssembly": { "type": "string" }, "jobOperation": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "status": { "type": "string" }, "timecardType": { "type": "string" }, "goodQty": { "type": "number", "format": "double" }, "scrapQty": { "type": "number", "format": "double" }, "reworkQty": { "type": "number", "format": "double" }, "rejectQty": { "type": "number", "format": "double" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "machineHours": { "type": "number", "format": "double" }, "laborHours": { "type": "number", "format": "double" }, "employeeID": { "type": "integer", "format": "int32" }, "timecardDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "workCenters": { "type": "array", "items": { "$ref": "#/components/schemas/WorkCenter" } }, "workCenter": { "$ref": "#/components/schemas/WorkCenter" }, "timecards": { "type": "array", "items": { "$ref": "#/components/schemas/Timecard" } }, "timecard": { "$ref": "#/components/schemas/Timecard" }, "jobs": { "$ref": "#/components/schemas/Job" }, "job": { "$ref": "#/components/schemas/Job" }, "processes": { "$ref": "#/components/schemas/Process" }, "process": { "$ref": "#/components/schemas/Process" }, "jobOperations": { "$ref": "#/components/schemas/JobOperation" }, "jobOperationx": { "$ref": "#/components/schemas/JobOperation" }, "salesOrderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDelivery" } }, "salesOrderJobs": { "$ref": "#/components/schemas/SalesOrderJob" }, "salesOrderJob": { "$ref": "#/components/schemas/SalesOrderJob" } } }, "UserInfoResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "Gets the User ID of the authenticated user.", "nullable": true }, "username": { "type": "string", "description": "Gets the User name of the authenticated user.", "nullable": true }, "expires": { "type": "string", "description": "Gets the expiration date of the current user's access token.", "format": "date-time", "nullable": true }, "companyId": { "type": "integer", "description": "Gets a unique identifier for the company being accessed. \r\n*Note* that this does *NOT* uniquely identify the database being accessed. \r\nA single company may have more than one database accessible via the ERP API.", "format": "int32" }, "companyName": { "type": "string", "description": "Gets the assigned company name. The format of this value varies by Product.", "nullable": true }, "companyCustomerId": { "type": "string", "description": "Gets the assigned customer ID value. The format of this value varies by Product.", "nullable": true }, "companyTimeZone": { "type": "string", "description": "Gets a value that indicates the time zone of the company being accessed.", "nullable": true }, "productId": { "type": "integer", "description": "The unique product identifier.", "format": "int32" }, "productName": { "type": "string", "description": "The product name.", "nullable": true }, "integrationName": { "type": "string", "description": "The name of the integration that the authenticated user is able to use.", "nullable": true }, "systemName": { "type": "string", "description": "The name of the integration system that the authenticated user is able to use.", "nullable": true } }, "additionalProperties": false }, "ValidValue": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidValueSet": { "type": "object", "properties": { "description": { "type": "string", "description": "A description of the valid value set.", "nullable": true }, "unique": { "type": "boolean", "description": "A value indicating if the values in this set are unique or can contain multiple values with the same code." }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ValidValue" }, "description": "A collection of valid values for this set.", "nullable": true }, "resultCount": { "type": "integer", "description": "The number of valid values in the collection for this set.", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "WorkCenter": { "title": "WorkCenter", "type": "object", "properties": { "workCenterID": { "type": "string" }, "shortDesc": { "type": "string" }, "deptID": { "type": "string" }, "overHeadRate": { "type": "string" }, "quoteRate": { "type": "string" }, "processID": { "type": "string" }, "parentWorkCenterID": { "type": "string" }, "shiftID": { "type": "string" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "laborRate": { "type": "string" }, "departments": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } }, "shifts": { "type": "array", "items": { "$ref": "#/components/schemas/Shift" } } } }, "WorkCenterRateBreak": { "title": "WorkCenterRateBreak", "type": "object", "properties": { "workCenterID": { "type": "string" }, "shortDesc": { "type": "string" }, "ordinal": { "type": "integer" }, "setupRate": { "type": "number", "format": "double" }, "prodRate": { "type": "number", "format": "double" }, "uniqueID": { "type": "string" }, "rowVersion": { "type": "integer", "format": "int64" }, "laborRate": { "type": "string" } } } }, "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": [ ] } ] }