{ "openapi": "3.0.1", "info": { "title": "M1 Public API", "description": "\n\r\n## Developer Notes for the M1 Public API (ERP resource):\n\r\n### Hosted Environment\n\r\nIf you are using the public API for a hosted M1 customer, you must connect to the public API using the Integration Engine. Please contact M1 Support to assist with this process.\n\r\n### Date and Time Fields\n\r\nAll dates submitted to the API are assumed to be in local time. Likewise, all dates returned from the API are in local time.\n\r\n**Format of Date/Time Fields**\n\r\nWhen submitting date and datetime fields through the Web API, values should match the following formats `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-dd`\n\r\n### Filter Expressions\n\r\nFor resources that support filtering, filter expressions can be applied as query string parameters in the format `M1Field[operator]value`\n\r\n**Operators**\n\r\n- `[eq]` Equal to the given value.\n\r\n- `[ne]` Not Equal to the given value.\n\r\n- `[gt]` Greater than the given value.\n\r\n- `[gte]` Greater than or equal to the given value.\n\r\n- `[lt]` Less than the given value.\n\r\n- `[lte]` Less than or equal to the given value.\n\r\n- `[null]` Is Null. To test if a field is null use `fieldName[NULL]=true`. To test if not null, use `fieldName[NULL]=false`.\n\r\n- `[like]` Like. To test if a field contains a value, use `fieldName[LIKE]%value%`. To test if a field starts with a value, use `fieldName[LIKE]value%`. To test if a field ends with a value, use `fieldName[LIKE]%value` The % must be url encoded to %25.\n\r\nExample:\n\r\n`?filter=impPartID[eq]CLIP&filter=impPartType[eq]2`\n\r\nIf you have multiple filters to apply, add them as separate filter query parameters.\n\r\n### Paging Parameters\n\r\nThe parameters `pageSize` and `pageNumber` can be provided separately but can be combined to implement server-side paging of results.\n\r\nExample:\n\r\n`?pageSize=100&pageNumber=5`\n\r\nPage Size defaults to 1000, which is also the maximum.\n\r\nPage Number defaults to 0, which is first page of results.\n\r\n### Order By Expressions\n\r\nFor resources that support sorting, the order by expression is specified by adding the orderBy query string parameter in the format `M1Field[Operator],M1Field[Operator]`. The following operators are supported: `Asc` or `Desc`\n\r\nExample:\n\r\n`?orderBy=impPartID[Asc],impPartType[Desc]`\n\r\n### Concurrency Checking\n\r\nUnless otherwise noted, the PUT endpoint requires the row version field from all standard tables to be specified. This will ensure a concurrency check is performed and will make it less likely data is overwritten. If the row version is not the current value, the server will respond with an HTTP 409 Conflict status. This is likely an indication that another user has modified this record since you retrieved it. To resolve, retrieve the record again and include the current row version value.\n\r\n### Error Responses\n\r\nIn general throughout the API, a 400 Bad Request Error is returned when invalid data is sent.\n\r\nError responses are return in the JSON format shown below:\n\r\n**A sample 400 Bad Request or 500 Internal Server Error**\n\r\n```json\r\n{\r\n \"description\": \"\",\r\n \"status\": \"Error\",\r\n \"payloadID\": \"\",\r\n \"errors\": [\r\n {\r\n \"innerText\": \"Filter clause passed 'impPartType[foo]12' is invalid.\"\r\n }\r\n ],\r\n \"warnings\": []\r\n}\r\n```\n\r\n### Product Code\n\r\nTo use the BOM/EDI or ERP APIs, you require a product code issued by ECI. Please contact your account manager for further information.\n\r\n", "contact": { "name": "ECI Software Solutions - M1", "url": "https://www.ecisolutions.com/manufacturers-and-job-shops/m1" }, "version": "v1" }, "servers": [ { "url": "https://api-m1.integrations.ecimanufacturing.com", "description": "API Host" } ], "paths": { "/api/BOM/Core/GetPartClassesAll/{pageNo}/{pageSize}": { "get": { "tags": [ "BOM/CORE" ], "summary": "Returns list of all active part classes", "operationId": "BOMCore_GetPartClassesAllAsync", "parameters": [ { "name": "pageNo", "in": "path", "description": "The page number if wants to get a specific page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "path", "description": "The total numbers of items should be on a page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMPartClassesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMPartClassesDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMPartClassesDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMPartClassesDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Core/GetPartGroupsAll/{pageNo}/{pageSize}": { "get": { "tags": [ "BOM/CORE" ], "summary": "Returns list of all active part groups", "operationId": "BOMCore_GetPartGroupsAllAsync", "parameters": [ { "name": "pageNo", "in": "path", "description": "The page number if wants to get a specific page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "path", "description": "The total numbers of items should be on a page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMPartGroupsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMPartGroupsDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMPartGroupsDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMPartGroupsDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Core/GetProcessesAll/{pageNo}/{pageSize}": { "get": { "tags": [ "BOM/CORE" ], "summary": "Returns list of all active processes", "operationId": "BOMCore_GetProcessesAllAsync", "parameters": [ { "name": "pageNo", "in": "path", "description": "The page number if wants to get a specific page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "path", "description": "The total numbers of items should be on a page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMProcessDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMProcessDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMProcessDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMProcessDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Core/GetWorkCentersAll/{pageNo}/{pageSize}": { "get": { "tags": [ "BOM/CORE" ], "summary": "Returns list of all active workcenters", "operationId": "BOMCore_GetWorkCentersAllAsync", "parameters": [ { "name": "pageNo", "in": "path", "description": "The page number if wants to get a specific page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "path", "description": "The total numbers of items should be on a page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMWorkCenterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMWorkCenterDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMWorkCenterDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMWorkCenterDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Core/GetWarehousesAll/{pageNo}/{pageSize}": { "get": { "tags": [ "BOM/CORE" ], "summary": "Returns list of all active warehouses", "operationId": "BOMCore_GetWarehousesAllAsync", "parameters": [ { "name": "pageNo", "in": "path", "description": "The page number if wants to get a specific page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "path", "description": "The total numbers of items should be on a page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMWarehousesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMWarehousesDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMWarehousesDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMWarehousesDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Core/GetWarehouseBinsAll/{pageNo}/{pageSize}": { "get": { "tags": [ "BOM/CORE" ], "summary": "Returns list of all active warehouse bins", "operationId": "BOMCore_GetWarehouseBinsAllAsync", "parameters": [ { "name": "pageNo", "in": "path", "description": "The page number if wants to get a specific page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "path", "description": "The total numbers of items should be on a page as integer.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMWarehouseBinsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMWarehouseBinsDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMWarehouseBinsDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMWarehouseBinsDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJobGUIDs/{jobId}/{partId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns GUIDs for a given jobid and/or partid. Do not use special charactors or url reserved charactors for parameter values.", "operationId": "BOMJob_GetJobGUIDsAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The jobId or section of jobid as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "partId", "in": "path", "description": "The partId or section of partid as string (optional)", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobGuidsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobGuidsDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobGuidsDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobGuidsDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJobMethod/{jobId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns job details for a given M1 job id or GUID. Do not pass job id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMJob_GetJobMethodAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The M1 job Id or GUID of the job as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMJobMethodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMJobMethodDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMJobMethodDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMJobMethodDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetAllJobs/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns a list of all BOM jobs with pagination.", "operationId": "BOMJob_GetAllJobAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The number of items to include in each page. Default is 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The page number to retrieve. Default is 0.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJob/{jobId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns a specific BOM job based on the provided job ID.", "operationId": "BOMJob_GetJobAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The unique identifier of the job to retrieve.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/PostJob": { "post": { "tags": [ "BOM/JOB" ], "summary": "Posts a new BOM job.", "operationId": "BOMJob_PostJobAsync", "requestBody": { "description": "The BOM job data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/CTMJobDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMJobDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CTMJobDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMJobDto" } } }, "required": true, "x-bodyName": "job" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/UpdateSchedulingDetails/{jobId}": { "post": { "tags": [ "BOM/JOB" ], "summary": "Updates the scheduling details for a specific job.", "operationId": "BOMJob_UpdateSchedulingDetailsAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The ID of the job to be patched.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The job data transfer object containing the details of the job to be patched.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/APSJobDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APSJobDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APSJobDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APSJobDto" } } }, "required": true, "x-bodyName": "job" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APSResponseMessageDto[CTMAPSJobDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APSResponseMessageDto[CTMAPSJobDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APSResponseMessageDto[CTMAPSJobDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APSResponseMessageDto[CTMAPSJobDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJobAssembly/{jobId}/{jobAssemblyId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns job assembly details for a given job and assembly id.", "operationId": "BOMJobAssemblies_GetJobAssemblyAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The job id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "jobAssemblyId", "in": "path", "description": "The job assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJobAssemblies/{jobId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns JobAssembly for a given JobAssembly id.", "description": "This endpoint retrieves a JobAssembly based on its identifier.", "operationId": "BOMJobAssemblies_GetJobAssemblyAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The Job id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetAllJobAssemblies/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns all existing JobAssemblies with pagination.", "operationId": "BOMJobAssemblies_GetAllJobAssemblyAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/PostJobAssembly": { "post": { "tags": [ "BOM/JOB" ], "summary": "Creates a job assembly based on input parameter.", "operationId": "BOMJobAssemblies_PostJobAssemblyAsync", "requestBody": { "description": "The jobassembly as BOMJobAssemblyDto", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobAssemblyDto" } } }, "required": true, "x-bodyName": "jobAssembly" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/DeleteJobAssembly/{jobId}/{jobAssemblyId}": { "delete": { "tags": [ "BOM/JOB" ], "summary": "Deletes a job assembly based on input parameters.", "operationId": "BOMJobAssemblies_DeleteJobAssemblyAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The job id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "jobAssemblyId", "in": "path", "description": "The job assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJobMaterial/{jobId}/{jobAssemblyId}/{jobMaterialId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns job material details for a given job,assembly and material id.", "operationId": "BOMJobMaterials_GetJobMaterialAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The job id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "jobAssemblyId", "in": "path", "description": "The job assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "jobMaterialId", "in": "path", "description": "The job material id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetAllJobMaterials/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns all existing JobMaterials with pagination.", "operationId": "BOMJobMaterials_GetAllJobMaterialAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/PostJobMaterial": { "post": { "tags": [ "BOM/JOB" ], "summary": "Posts a new JobMaterial.", "operationId": "BOMJobMaterials_PostJobMaterialAsync", "requestBody": { "description": "The JobMaterial data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } }, "required": true, "x-bodyName": "jobMaterial" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/DeleteJobMaterial/{jobId}/{jobAssemblyId}/{jobMaterialId}": { "delete": { "tags": [ "BOM/JOB" ], "summary": "Deletes a job material based on input parameters.", "operationId": "BOMJobMaterials_DeleteJobMaterialAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The job id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "jobAssemblyId", "in": "path", "description": "The job assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "jobMaterialId", "in": "path", "description": "The job material id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetJobOperation/{jobId}/{jobAssemblyId}/{jobOperationId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns job operation details for a given job,assembly and operation id.", "operationId": "BOMJobOperations_GetJobOperationAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The job id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "jobAssemblyId", "in": "path", "description": "The job assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "jobOperationId", "in": "path", "description": "The job operation id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetAllJobOperations/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns all existing JobOperations with pagination.", "operationId": "BOMJobOperations_GetAllJobOperationAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobOperationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobOperationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobOperationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobOperationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/PostJobOperation": { "post": { "tags": [ "BOM/JOB" ], "summary": "Posts a new JobOperation.", "operationId": "BOMJobOperations_PostJobOperationAsync", "requestBody": { "description": "The JobOperation data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } } }, "required": true, "x-bodyName": "jobOperation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/DeleteJobOperation/{jobId}/{jobAssemblyId}/{jobOperationId}": { "delete": { "tags": [ "BOM/JOB" ], "summary": "Deletes a job operation based on input parameters.", "operationId": "BOMJobOperations_DeleteJobOperationAsync", "parameters": [ { "name": "jobId", "in": "path", "description": "The job id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "jobAssemblyId", "in": "path", "description": "The job assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "jobOperationId", "in": "path", "description": "The job operation id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMJobOperationDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetAllTimecardLines/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns all existing TimecardLines with pagination.", "operationId": "BOMTimecardLines_GetAllTimecardLineAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardLineDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardLineDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardLineDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardLineDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetTimecardLine/{timecardId}/{timecardLineId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns TimecardLine for a given Timecard id containing TimecardLine id.", "description": "This endpoint retrieves a TimecardLine based on its identifier.", "operationId": "BOMTimecardLines_GetTimecardLineAsync", "parameters": [ { "name": "timecardId", "in": "path", "description": "The Timecard id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "timecardLineId", "in": "path", "description": "The TimecardLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMTimecardLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMTimecardLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMTimecardLineDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMTimecardLineDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetAllTimecards/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns all existing Timecards with pagination.", "operationId": "BOMTimecards_GetAllTimecardAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMTimecardDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetTimecard/{timecardId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns Timecard for a given Timecard id.", "description": "This endpoint retrieves a Timecard based on its identifier.", "operationId": "BOMTimecards_GetTimecardAsync", "parameters": [ { "name": "timecardId", "in": "path", "description": "The Timecard id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Job/GetTimecard/{timecardId}/{employeeId}": { "get": { "tags": [ "BOM/JOB" ], "summary": "Returns Timecard for a given Timecard id and Employee id.", "description": "This endpoint retrieves a Timecard based on timecard and employee identifier.", "operationId": "BOMTimecards_GetTimecardByEmployeeIdAsync", "parameters": [ { "name": "timecardId", "in": "path", "description": "The Timecard id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "employeeId", "in": "path", "description": "The Employee id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMTimecardDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/GetAllOrganizations/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Returns all existing organizations with pagination.", "operationId": "BomOrganization_GetAllOrganizationsAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BomOrganizationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BomOrganizationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BomOrganizationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BomOrganizationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/GetOrganization/{organizationId}": { "get": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Returns organization for a given organization id.", "operationId": "BomOrganization_GetOrganizationAsync", "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BomOrganizationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BomOrganizationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BomOrganizationDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BomOrganizationDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/GetAllOrganizationContacts/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Returns all existing OrganizationContacts with pagination.", "operationId": "BOMOrganizationContacts_GetAllOrganizationContactAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/GetOrganizationContact/{organizationId}/{locationId}/{contactId}": { "get": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Returns OrganizationContact for a given Organization id, Location id and Contact id", "description": "This endpoint retrieves a OrganizationContact based on Organization Id, Location Id and its identifier.", "operationId": "BOMOrganizationContacts_GetOrganizationContactAsync", "parameters": [ { "name": "organizationId", "in": "path", "description": "The Organization id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "description": "The Location id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "description": "The Contact id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMOrganizationContactDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/PostOrganizationContact": { "post": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Posts a new OrganizationContact.", "operationId": "BOMOrganizationContacts_PostOrganizationContactAsync", "requestBody": { "description": "The OrganizationContact data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMOrganizationContactDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMOrganizationContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMOrganizationContactDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMOrganizationContactDto" } } }, "required": true, "x-bodyName": "organizationContact" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/GetAllOrganizationLocations/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Returns all existing OrganizationLocations with pagination.", "operationId": "BOMOrganizationLocations_GetAllOrganizationLocationAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/GetOrganizationLocation/{organizationId}/{organizationLocationId}": { "get": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Returns OrganizationLocation for a given Organization Id and OrganizationLocation id.", "description": "This endpoint retrieves a OrganizationLocation based on Organization Id and its identifier.", "operationId": "BOMOrganizationLocations_GetOrganizationLocationAsync", "parameters": [ { "name": "organizationId", "in": "path", "description": "The Organization id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "organizationLocationId", "in": "path", "description": "The OrganizationLocation id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMOrganizationLocationDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Organization/PostOrganizationLocation": { "post": { "tags": [ "BOM/ORGANIZATION" ], "summary": "Posts a new OrganizationLocation.", "operationId": "BOMOrganizationLocations_PostOrganizationLocationAsync", "requestBody": { "description": "The OrganizationLocation data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMOrganizationLocationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMOrganizationLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMOrganizationLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMOrganizationLocationDto" } } }, "required": true, "x-bodyName": "organizationLocation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetParts/{partId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part details for a given M1 part id or GUID. Do not pass part id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMPart_GetPartsByIdAsync", "parameters": [ { "name": "partId", "in": "path", "description": "The M1 Part Id or GUID of the part as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetAllParts/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns all existing parts with pagination.", "operationId": "BOMPart_GetAllPartsAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/PostParts": { "post": { "tags": [ "BOM/PART" ], "summary": "Creates a part with the required attributes.", "operationId": "BOMPart_PostPartAsync", "requestBody": { "description": "The part object as BOMPartDto with the incoming data.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartDto" } } }, "required": true, "x-bodyName": "part" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartRevisions/{partId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part and part revision details for a given M1 part id or GUID. Do not pass part id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMPart_GetPartRevisionsAsync", "parameters": [ { "name": "partId", "in": "path", "description": "The M1 Part Id or GUID of the part as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/PostPartRevisions": { "post": { "tags": [ "BOM/PART" ], "summary": "Creates a part and relevant part revisions based on input parameter.", "operationId": "BOMPart_PostPartRevisionsAsync", "requestBody": { "description": "The part revision object as CTMBOMPartRevisionDto", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } } }, "required": true, "x-bodyName": "partRevision" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartAssembly/{methodId}/{methodRevisionId}/{methodAssemblyId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part and part assembly details for a given M1 method id, method revision id and method assembly id. Alternatively it can be used the method assembly Guid.", "operationId": "BOMPart_GetPartAssemblyAsync", "parameters": [ { "name": "methodId", "in": "path", "description": "The part method id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodRevisionId", "in": "path", "description": "The part method revision id as string. If wants to pass BLANK revision id, use underscore (\"_\") character instead", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodAssemblyId", "in": "path", "description": "The part method assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartAssembly/{methodAsmGuid}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part and part assembly details for a given M1 method assembly GUID.", "operationId": "BOMPart_GetPartAssemblyAsync", "parameters": [ { "name": "methodAsmGuid", "in": "path", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartRevisionDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/PostPartAssembly": { "post": { "tags": [ "BOM/PART" ], "summary": "Creates a part assembly based on input parameter.", "operationId": "BOMPart_PostPartAssemblyAsync", "requestBody": { "description": "The part assembly object as BOMPartAssembly", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartAssemblyDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartAssemblyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartAssemblyDto" } } }, "required": true, "x-bodyName": "partAssembly" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/DeletePartAssembly/{methodId}/{methodRevisionId}/{methodAssemblyId}": { "delete": { "tags": [ "BOM/PART" ], "summary": "Deletes a part assembly for method id, method revision id and method assembly id. Do not use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_DeletePartAssemblyAsync", "parameters": [ { "name": "methodId", "in": "path", "description": "The part method id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodRevisionId", "in": "path", "description": "The part method revision id as string. If wants to pass BLANK revision id, use underscore (\"_\") character instead", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodAssemblyId", "in": "path", "description": "The part method assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/DeletePartAssembly/{methodAsmGuid}": { "delete": { "tags": [ "BOM/PART" ], "summary": "Deletes a part assembly for method assembly GUID. Use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_DeletePartAssemblyAsync", "parameters": [ { "name": "methodAsmGuid", "in": "path", "description": "The methodAsmGuid as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/PostPartOperation": { "post": { "tags": [ "BOM/PART" ], "summary": "Creates a part operation based on input parameter.", "operationId": "BOMPart_PostPartOperationAsync", "requestBody": { "description": "The part operation as BOMPartAssembly", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartOperationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartOperationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartOperationDto" } } }, "required": true, "x-bodyName": "partOperation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/DeletePartOperation/{methodId}/{methodRevisionId}/{methodAssemblyId}/{methodOperationId}": { "delete": { "tags": [ "BOM/PART" ], "summary": "Deletes a part operation for method id, method revision id, method assembly id and method operation id. Do not use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_DeletePartOperationAsync", "parameters": [ { "name": "methodId", "in": "path", "description": "The part method id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodRevisionId", "in": "path", "description": "The part method revision id as string. If wants to pass BLANK revision id, use underscore (\"_\") character instead", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodAssemblyId", "in": "path", "description": "The part method assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "methodOperationId", "in": "path", "description": "The part method operation id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/DeletePartOperation/{methodOperationGuid}": { "delete": { "tags": [ "BOM/PART" ], "summary": "Deletes a part operation for method operation GUID. Use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_DeletePartOperationAsync", "parameters": [ { "name": "methodOperationGuid", "in": "path", "description": "The methodOperationGuid as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartMaterial/{methodId}/{methodRevisionId}/{methodAssemblyId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns all part materials for the given combination of identifiers: methodId, revisionId and assemblyId.", "operationId": "BOMPart_GetPartMaterialAsync", "parameters": [ { "name": "methodId", "in": "path", "description": "The M1 Part Method Id", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodRevisionId", "in": "path", "description": "The M1 Part Method Revision Id. If wants to pass BLANK revision id, use underscore (\"_\") character instead.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodAssemblyId", "in": "path", "description": "The M1 Part Method Assembly Id.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartMaterial/{methodMaterialGuid}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part material for method material GUID. Use this method if you have special characters (other than Aa-Zz0-9.-) in key fields.", "operationId": "BOMPart_GetPartMaterialAsync", "parameters": [ { "name": "methodMaterialGuid", "in": "path", "description": "The methodMaterialGuid as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/PostPartMaterial": { "post": { "tags": [ "BOM/PART" ], "summary": "Creates a part material based on input parameter.", "operationId": "BOMPart_PostPartMaterialAsync", "requestBody": { "description": "The part material as BOMPartMaterialDto", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartMaterialDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartMaterialDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "required": true, "x-bodyName": "partMaterial" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMResponseMessageDto[BOMPartMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMResponseMessageDto[BOMPartMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMResponseMessageDto[BOMPartMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMResponseMessageDto[BOMPartMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/DeletePartMaterial/{methodId}/{methodRevisionId}/{methodAssemblyId}/{methodMaterialId}": { "delete": { "tags": [ "BOM/PART" ], "summary": "Deletes a part material for method id, method revision id, method assembly id and method material id. Do not use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_DeletePartMaterialAsync", "parameters": [ { "name": "methodId", "in": "path", "description": "The part method id as string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodRevisionId", "in": "path", "description": "The part method revision id as string. If wants to pass BLANK revision id, use underscore (\"_\") character instead", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "methodAssemblyId", "in": "path", "description": "The part method assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "methodMaterialId", "in": "path", "description": "The part method material id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/DeletePartMaterial/{methodMaterialGuid}": { "delete": { "tags": [ "BOM/PART" ], "summary": "Deletes a part material for method material GUID. Use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_DeletePartMaterialAsync", "parameters": [ { "name": "methodMaterialGuid", "in": "path", "description": "The methodMaterialGuid as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartMethodBOM/{partId}/{partRevisionId}/{partAssemblyId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part method BOM details for a given M1 part,revision and assembly. Do not use this method if you have special characters (other than Aa-Zz0-9.-) in key fields", "operationId": "BOMPart_GetPartMethodBomAsync", "parameters": [ { "name": "partId", "in": "path", "description": "The M1 Part Id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "partRevisionId", "in": "path", "description": "The part revision id as string. If wants to pass BLANK revision id, use underscore (\"_\") character instead", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "partAssemblyId", "in": "path", "description": "The part assembly id as integer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartMethodBOM/{partAssemblyGuid}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part method BOM details for a given part assembly guid. Use this method if you have special characters (other than Aa-Zz0-9.-) in part assembly key fields", "operationId": "BOMPart_GetPartMethodBomAsync", "parameters": [ { "name": "partAssemblyGuid", "in": "path", "description": "The partAssemblyGuid as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartMethodGUIDs/{partId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part method GUIDs for a given part. Do not use special characters or url reserved characters for parameter values", "operationId": "BOMPart_GetPartMethodGuidsAsync", "parameters": [ { "name": "partId", "in": "path", "description": "The partId or section of partId as string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodGuidsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodGuidsDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodGuidsDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMPartMethodGuidsDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetPartBinDetails/{partId}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns part and part bin details for a given M1 part id or GUID. Do not pass part id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMPartBinDetail_GetPartBinDetailsAsync", "parameters": [ { "name": "partId", "in": "path", "description": "The M1 Part Id or GUID of the part as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Part/GetAllPartBinDetails/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/PART" ], "summary": "Returns all existing part bin details with pagination.", "operationId": "BOMPartBinDetail_GetAllPartBinDetailsAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartBinDetailDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllQuoteAssemblies/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing QuoteAssemblies with pagination.", "operationId": "BOMQuoteAssemblies_GetAllQuoteAssemblyAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteAssemblies/{quoteId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteAssemblies for a given Quote id.", "description": "This endpoint retrieves a list of QuoteAssemblies based on Quote identifier.", "operationId": "BOMQuoteAssemblies_GetQuoteAssemblyAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteAssemblies/{quoteId}/{quoteLineId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteAssemblies for a given Quote id and Quote Line id.", "description": "This endpoint retrieves a list of QuoteAssemblies based on Quote and QuoteLine identifier.", "operationId": "BOMQuoteAssemblies_GetQuoteAssemblyAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The QuoteLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteAssemblyDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/PostQuoteAssembly": { "post": { "tags": [ "BOM/SALES" ], "summary": "Posts a new QuoteAssembly.", "operationId": "BOMQuoteAssemblies_PostQuoteAssemblyAsync", "requestBody": { "description": "The QuoteAssembly data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteAssemblyDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteAssemblyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteAssemblyDto" } } }, "required": true, "x-bodyName": "quoteAssembly" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllQuoteLines/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing QuoteLines with pagination.", "operationId": "BOMQuoteLines_GetAllQuoteLineAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteLineDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteLineDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteLineDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteLineDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteLines/{quoteId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns quote and quote lines details for a given M1 quote id or GUID. Do not pass quote id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMQuoteLines_GetQuoteLinesAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The M1 Quote Id or GUID of the quote as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMQuoteLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMQuoteLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMQuoteLineDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMQuoteLineDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteLine/{quoteId}/{quoteLineId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteLine for a given Quote id and QuoteLine Id.", "description": "This endpoint retrieves a QuoteLine identified by the Quote identifier and its own unique identifier.", "operationId": "BOMQuoteLines_GetQuoteLineAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The QuoteLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMQuoteLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMQuoteLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMQuoteLineDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMQuoteLineDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/PostQuoteLine": { "post": { "tags": [ "BOM/SALES" ], "summary": "Posts a new QuoteLine.", "operationId": "BOMQuoteLines_PostQuoteLineAsync", "requestBody": { "description": "The QuoteLine data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteLineDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteLineDto" } } }, "required": true, "x-bodyName": "quoteLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllQuoteMaterials/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing QuoteMaterials with pagination.", "operationId": "BOMQuoteMaterials_GetAllQuoteMaterialAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteMaterials/{quoteId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns a list of QuoteMaterial for a given Quote id.", "description": "This endpoint retrieves QuoteMaterials based on Quote identifier.", "operationId": "BOMQuoteMaterials_GetQuoteMaterialAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteMaterials/{quoteId}/{quoteLineId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns a list of QuoteMaterial for a given QuoteId and QuoteLineId.", "description": "This endpoint retrieves QuoteMaterials based on QuoteId and QuoteLineId.", "operationId": "BOMQuoteMaterials_GetQuoteMaterialAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The QuoteLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteMaterials/{quoteId}/{quoteLineId}/{quoteAssemblyId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns a list of QuoteMaterial for a given QuoteId, QuoteLineId and QuoteAssemblyId.", "description": "This endpoint retrieves QuoteMaterials based on QuoteId, QuoteLineId and QuoteAssemblyId.", "operationId": "BOMQuoteMaterials_GetQuoteMaterialAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The QuoteLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteAssemblyId", "in": "path", "description": "The QuoteAssembly id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteMaterialDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/PostQuoteMaterial": { "post": { "tags": [ "BOM/SALES" ], "summary": "Posts a new QuoteMaterial.", "operationId": "BOMQuoteMaterials_PostQuoteMaterialAsync", "requestBody": { "description": "The QuoteMaterial data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteMaterialDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteMaterialDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteMaterialDto" } } }, "required": true, "x-bodyName": "quoteMaterial" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllQuoteOperations/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing QuoteOperations with pagination.", "operationId": "BOMQuoteOperations_GetAllQuoteOperationAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteOperations/{quoteId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns a list of QuoteOperations for a given Quote id.", "description": "This endpoint retrieves a list of QuoteOperations based on Quote identifier.", "operationId": "BOMQuoteOperations_GetQuoteOperationsAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteOperations/{quoteId}/{quoteLineId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteOperation for a given Quote and QuoteLine id.", "description": "This endpoint retrieves a list of QuoteOperations based on Quote and QuoteLine identifiers.", "operationId": "BOMQuoteOperations_GetQuoteOperationsAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The QuoteLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteOperations/{quoteId}/{quoteLineId}/{quoteAssemblyId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteOperation for a given Quote, QuoteLine, and QuoteAssembly id.", "description": "This endpoint retrieves a list of QuoteOperations based on Quote, QuoteLine and QuoteAssembly identifiers.", "operationId": "BOMQuoteOperations_GetQuoteOperationsAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The QuoteLine id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteAssemblyId", "in": "path", "description": "The QuoteAssembly id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteOperationDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllQuoteQuantities/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing QuoteQuantities with pagination.", "operationId": "BOMQuoteQuantities_GetAllQuoteQuantityAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteQuantities/{quoteId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteQuantities for a given Quote Id.", "description": "Returns all existing QuoteQuantities for a QuoteId.", "operationId": "BOMQuoteQuantities_GetQuoteQuantityAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuoteQuantities/{quoteId}/{quoteLineId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns QuoteQuantities for a given Quote Id and Quote Line Id.", "description": "Returns all existing QuoteQuantities for a QuoteId and Quote Line Id.", "operationId": "BOMQuoteQuantities_GetQuoteQuantityAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "quoteLineId", "in": "path", "description": "The Quote Line id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteQuantityDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllQuotes/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing Quotes with pagination.", "operationId": "BOMQuotes_GetAllQuoteAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetQuote/{quoteId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns Quote for a given Quote id.", "description": "This endpoint retrieves a Quote based on its identifier.", "operationId": "BOMQuotes_GetQuoteAsync", "parameters": [ { "name": "quoteId", "in": "path", "description": "The Quote id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMQuoteDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMQuoteDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMQuoteDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMQuoteDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/PostQuote": { "post": { "tags": [ "BOM/SALES" ], "summary": "Posts a new Quote.", "operationId": "BOMQuotes_PostQuoteAsync", "requestBody": { "description": "The Quote data to be posted.", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMCreateQuoteDto" } } }, "required": true, "x-bodyName": "quote" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetAllSalesOrders/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns all existing SalesOrders with pagination.", "operationId": "BOMSalesOrders_GetAllSalesOrderAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMSalesOrderDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMSalesOrderDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMSalesOrderDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMSalesOrderDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Sales/GetSalesOrder/{salesOrderId}": { "get": { "tags": [ "BOM/SALES" ], "summary": "Returns SalesOrder for a given SalesOrder id.", "description": "This endpoint retrieves a SalesOrder based on its identifier.", "operationId": "BOMSalesOrders_GetSalesOrderAsync", "parameters": [ { "name": "salesOrderId", "in": "path", "description": "The SalesOrder id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMSalesOrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMSalesOrderDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMSalesOrderDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMSalesOrderDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/MaterialIssueLine/GetAllMaterialIssueLines/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns all existing MaterialIssueLines with pagination.", "operationId": "BOMMaterialIssueLines_GetAllMaterialIssueLineAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueLineDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueLineDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueLineDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueLineDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/MaterialIssueLine/GetMaterialIssueLines/{materialIssueId}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns material issue lines for a given M1 material issue id. Do not pass material issue id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMMaterialIssueLines_GetMaterialIssueLinesAsync", "parameters": [ { "name": "materialIssueId", "in": "path", "description": "The M1 material issue Id or GUID of the material issue as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/CTMBOMMaterialIssueLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CTMBOMMaterialIssueLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMMaterialIssueLineDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CTMBOMMaterialIssueLineDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/MaterialIssue/GetAllMaterialIssues/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns all existing MaterialIssues with pagination.", "operationId": "BOMMaterialIssues_GetAllMaterialIssuesAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/MaterialIssue/GetMaterialIssue/{materialIssueId}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns material issue for a given M1 material issue id. Do not pass material issue id if it has special characters (other than Aa-Zz0-9.-) pass GUID instead", "operationId": "BOMMaterialIssues_GetMaterialIssueAsync", "parameters": [ { "name": "materialIssueId", "in": "path", "description": "The M1 material issue Id or GUID of the material issue as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMMaterialIssueDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/MfgReceipt/GetAllMfgReceipts/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns all existing MfgReceipts with pagination.", "operationId": "BOMMfgReceipts_GetAllMfgReceiptAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The required size of the pagination. By default 1000.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The required number of page from pagination. By default 0, which is the first page.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/MfgReceipt/GetMfgReceipt/{mfgReceiptId}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns mfg receipt for a given mfg receipt id.", "description": "This endpoint retrieves a mfg receipt based on its identifier.", "operationId": "BOMMfgReceipts_GetMfgReceiptAsync", "parameters": [ { "name": "mfgReceiptId", "in": "path", "description": "The mfg receipt id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMMfgReceiptDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/Receipt/GetAllReceipts/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Retrieves all M1 receipts with pagination support.", "description": "This endpoint returns a paginated list of all receipts. Pagination is supported via the pageSize and pageNumber parameters.", "operationId": "BOMReceipt_GetAllReceiptsAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The number of receipts to return per page (default: 1000).", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The page number to retrieve (default: 0).", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/Receipt/GetReceipt/{receiptId}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns receipt for a given receipt id.", "description": "This endpoint retrieves a receipt based on its identifier.", "operationId": "BOMReceipt_GetReceiptAsync", "parameters": [ { "name": "receiptId", "in": "path", "description": "The receipt id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMReceiptDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMReceiptDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMReceiptDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMReceiptDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/ReceiptLine/GetAllReceiptLines/{pageSize}/{pageNumber}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Retrieves all M1 receipt lines with pagination support.", "description": "This endpoint returns a paginated list of all receipt lines. Pagination is supported via the pageSize and pageNumber parameters.", "operationId": "BOMReceiptLine_GetAllReceiptLinesAsync", "parameters": [ { "name": "pageSize", "in": "path", "description": "The number of receipt lines to return per page (default: 1000).", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "path", "description": "The page number to retrieve (default: 0).", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptLineDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptLineDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptLineDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BOMReceiptLineDto" } } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/BOM/Transaction/ReceiptLine/GetReceiptLine/{receiptId}": { "get": { "tags": [ "BOM/TRANSACTION" ], "summary": "Returns all receipt lines for a given receipt id.", "description": "This endpoint retrieves all receipt lines based on receipt identifier.", "operationId": "BOMReceiptLine_GetReceiptAsync", "parameters": [ { "name": "receiptId", "in": "path", "description": "The receipt id as a string", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/BOMReceiptLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BOMReceiptLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BOMReceiptLineDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BOMReceiptLineDto" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LaserCalculatorLines": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns all existing LaserCalculatorLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLaserCalculatorLines_GetAllLaserCalculatorLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CALCULATORS" ], "summary": "Creates or updates a single LaserCalculatorLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLaserCalculatorLines_PutLaserCalculatorLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLaserCalculatorLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLaserCalculatorLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLaserCalculatorLineDto" } } }, "required": true, "x-bodyName": "laserCalculatorLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LaserCalculatorLines/{key}": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns a single LaserCalculatorLine record for a given Unique Id.", "description": "This endpoint retrieves a LaserCalculatorLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLaserCalculatorLines_GetLaserCalculatorLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CALCULATORS" ], "summary": "Deletes a single LaserCalculatorLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLaserCalculatorLines_DeleteLaserCalculatorLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LaserCalculators": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns all existing LaserCalculators according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLaserCalculators_GetAllLaserCalculatorAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLaserCalculatorDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CALCULATORS" ], "summary": "Creates or updates a single LaserCalculator record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLaserCalculators_PutLaserCalculatorAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLaserCalculatorDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLaserCalculatorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLaserCalculatorDto" } } }, "required": true, "x-bodyName": "laserCalculator" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LaserCalculators/{key}": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns a single LaserCalculator record for a given Unique Id.", "description": "This endpoint retrieves a LaserCalculator based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLaserCalculators_GetLaserCalculatorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CALCULATORS" ], "summary": "Deletes a single LaserCalculator record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLaserCalculators_DeleteLaserCalculatorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLaserCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PunchCalculators": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns all existing PunchCalculators according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPunchCalculators_GetAllPunchCalculatorAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPunchCalculatorDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPunchCalculatorDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPunchCalculatorDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPunchCalculatorDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CALCULATORS" ], "summary": "Creates or updates a single PunchCalculator record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPunchCalculators_PutPunchCalculatorAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPunchCalculatorDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPunchCalculatorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPunchCalculatorDto" } } }, "required": true, "x-bodyName": "punchCalculator" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PunchCalculators/{key}": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns a single PunchCalculator record for a given Unique Id.", "description": "This endpoint retrieves a PunchCalculator based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPunchCalculators_GetPunchCalculatorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CALCULATORS" ], "summary": "Deletes a single PunchCalculator record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPunchCalculators_DeletePunchCalculatorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPunchCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SheetCalculators": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns all existing SheetCalculators according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSheetCalculators_GetAllSheetCalculatorAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSheetCalculatorDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSheetCalculatorDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSheetCalculatorDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSheetCalculatorDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CALCULATORS" ], "summary": "Creates or updates a single SheetCalculator record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSheetCalculators_PutSheetCalculatorAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSheetCalculatorDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSheetCalculatorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSheetCalculatorDto" } } }, "required": true, "x-bodyName": "sheetCalculator" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SheetCalculators/{key}": { "get": { "tags": [ "ERP/CALCULATORS" ], "summary": "Returns a single SheetCalculator record for a given Unique Id.", "description": "This endpoint retrieves a SheetCalculator based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSheetCalculators_GetSheetCalculatorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CALCULATORS" ], "summary": "Deletes a single SheetCalculator record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSheetCalculators_DeleteSheetCalculatorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSheetCalculatorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartRules": { "get": { "tags": [ "ERP/CONFIGURATOR" ], "summary": "Returns all existing PartRules according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartRules_GetAllPartRuleAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRuleDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRuleDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRuleDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRuleDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CONFIGURATOR" ], "summary": "Creates or updates a single PartRule record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartRules_PutPartRuleAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartRuleDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartRuleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartRuleDto" } } }, "required": true, "x-bodyName": "partRule" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartRules/{key}": { "get": { "tags": [ "ERP/CONFIGURATOR" ], "summary": "Returns a single PartRule record for a given Unique Id.", "description": "This endpoint retrieves a PartRule based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartRules_GetPartRuleAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CONFIGURATOR" ], "summary": "Deletes a single PartRule record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartRules_DeletePartRuleAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRuleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CallLines": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing CallLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCallLines_GetAllCallLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single CallLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCallLines_PutCallLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCallLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCallLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCallLineDto" } } }, "required": true, "x-bodyName": "callLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CallLines/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single CallLine record for a given Unique Id.", "description": "This endpoint retrieves a CallLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCallLines_GetCallLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single CallLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCallLines_DeleteCallLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CallMemos": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing CallMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCallMemos_GetAllCallMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single CallMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCallMemos_PutCallMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCallMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCallMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCallMemoDto" } } }, "required": true, "x-bodyName": "callMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CallMemos/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single CallMemo record for a given Unique Id.", "description": "This endpoint retrieves a CallMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCallMemos_GetCallMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single CallMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCallMemos_DeleteCallMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Calls": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing Calls according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCalls_GetAllCallAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single Call record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCalls_PutCallAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCallDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCallDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCallDto" } } }, "required": true, "x-bodyName": "call" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Calls/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single Call record for a given Unique Id.", "description": "This endpoint retrieves a Call based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCalls_GetCallAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single Call record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCalls_DeleteCallAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CallTypes": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing CallTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCallTypes_GetAllCallTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCallTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CallTypes/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single CallType record for a given Unique Id.", "description": "This endpoint retrieves a CallType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCallTypes_GetCallTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCallTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ContactGroups": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ContactGroups according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPContactGroups_GetAllContactGroupAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactGroupDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactGroupDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactGroupDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactGroupDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ContactGroup record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPContactGroups_PutContactGroupAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPContactGroupDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPContactGroupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPContactGroupDto" } } }, "required": true, "x-bodyName": "contactGroup" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ContactGroups/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ContactGroup record for a given Unique Id.", "description": "This endpoint retrieves a ContactGroup based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPContactGroups_GetContactGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ContactGroup record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPContactGroups_DeleteContactGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ContactMethods": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ContactMethods according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPContactMethods_GetAllContactMethodAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactMethodDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactMethodDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactMethodDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactMethodDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ContactMethod record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPContactMethods_PutContactMethodAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPContactMethodDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPContactMethodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPContactMethodDto" } } }, "required": true, "x-bodyName": "contactMethod" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ContactMethods/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ContactMethod record for a given Unique Id.", "description": "This endpoint retrieves a ContactMethod based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPContactMethods_GetContactMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ContactMethod record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPContactMethods_DeleteContactMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ContactTitles": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ContactTitles according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPContactTitles_GetAllContactTitleAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactTitleDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactTitleDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactTitleDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPContactTitleDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ContactTitle record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPContactTitles_PutContactTitleAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPContactTitleDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPContactTitleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPContactTitleDto" } } }, "required": true, "x-bodyName": "contactTitle" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ContactTitles/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ContactTitle record for a given Unique Id.", "description": "This endpoint retrieves a ContactTitle based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPContactTitles_GetContactTitleAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ContactTitle record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPContactTitles_DeleteContactTitleAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPContactTitleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CountyCodes": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing CountyCodes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCountyCodes_GetAllCountyCodeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCountyCodeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCountyCodeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCountyCodeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCountyCodeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single CountyCode record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCountyCodes_PutCountyCodeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCountyCodeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCountyCodeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCountyCodeDto" } } }, "required": true, "x-bodyName": "countyCode" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CountyCodes/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single CountyCode record for a given Unique Id.", "description": "This endpoint retrieves a CountyCode based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCountyCodes_GetCountyCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single CountyCode record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCountyCodes_DeleteCountyCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCountyCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CustomerGroups": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing CustomerGroups according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCustomerGroups_GetAllCustomerGroupAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerGroupDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerGroupDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerGroupDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerGroupDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single CustomerGroup record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCustomerGroups_PutCustomerGroupAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCustomerGroupDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCustomerGroupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCustomerGroupDto" } } }, "required": true, "x-bodyName": "customerGroup" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CustomerGroups/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single CustomerGroup record for a given Unique Id.", "description": "This endpoint retrieves a CustomerGroup based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCustomerGroups_GetCustomerGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single CustomerGroup record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCustomerGroups_DeleteCustomerGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Followups": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing Followups according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFollowups_GetAllFollowupAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFollowupDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFollowupDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFollowupDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFollowupDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single Followup record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFollowups_PutFollowupAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPFollowupDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPFollowupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPFollowupDto" } } }, "required": true, "x-bodyName": "followup" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Followups/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single Followup record for a given Unique Id.", "description": "This endpoint retrieves a Followup based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFollowups_GetFollowupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single Followup record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFollowups_DeleteFollowupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFollowupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/IndustryTypes": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing IndustryTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPIndustryTypes_GetAllIndustryTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndustryTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndustryTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndustryTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndustryTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single IndustryType record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPIndustryTypes_PutIndustryTypeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPIndustryTypeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPIndustryTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPIndustryTypeDto" } } }, "required": true, "x-bodyName": "industryType" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/IndustryTypes/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single IndustryType record for a given Unique Id.", "description": "This endpoint retrieves a IndustryType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPIndustryTypes_GetIndustryTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single IndustryType record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPIndustryTypes_DeleteIndustryTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndustryTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/KnowledgeBasePages": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing KnowledgeBasePages according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPKnowledgeBasePages_GetAllKnowledgeBasePageAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPKnowledgeBasePageDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPKnowledgeBasePageDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPKnowledgeBasePageDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPKnowledgeBasePageDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single KnowledgeBasePage record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPKnowledgeBasePages_PutKnowledgeBasePageAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPKnowledgeBasePageDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPKnowledgeBasePageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPKnowledgeBasePageDto" } } }, "required": true, "x-bodyName": "knowledgeBasePage" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/KnowledgeBasePages/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single KnowledgeBasePage record for a given Unique Id.", "description": "This endpoint retrieves a KnowledgeBasePage based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPKnowledgeBasePages_GetKnowledgeBasePageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single KnowledgeBasePage record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPKnowledgeBasePages_DeleteKnowledgeBasePageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPKnowledgeBasePageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadCompetitors": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing LeadCompetitors according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLeadCompetitors_GetAllLeadCompetitorAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadCompetitorDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadCompetitorDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadCompetitorDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadCompetitorDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single LeadCompetitor record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadCompetitors_PutLeadCompetitorAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLeadCompetitorDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLeadCompetitorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLeadCompetitorDto" } } }, "required": true, "x-bodyName": "leadCompetitor" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadCompetitors/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single LeadCompetitor record for a given Unique Id.", "description": "This endpoint retrieves a LeadCompetitor based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLeadCompetitors_GetLeadCompetitorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single LeadCompetitor record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadCompetitors_DeleteLeadCompetitorAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadCompetitorDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadLines": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing LeadLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLeadLines_GetAllLeadLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single LeadLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadLines_PutLeadLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLeadLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLeadLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLeadLineDto" } } }, "required": true, "x-bodyName": "leadLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadLines/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single LeadLine record for a given Unique Id.", "description": "This endpoint retrieves a LeadLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLeadLines_GetLeadLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single LeadLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadLines_DeleteLeadLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadMemos": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing LeadMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLeadMemos_GetAllLeadMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single LeadMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadMemos_PutLeadMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLeadMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLeadMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLeadMemoDto" } } }, "required": true, "x-bodyName": "leadMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadMemos/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single LeadMemo record for a given Unique Id.", "description": "This endpoint retrieves a LeadMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLeadMemos_GetLeadMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single LeadMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadMemos_DeleteLeadMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Leads": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing Leads according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLeads_GetAllLeadAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single Lead record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeads_PutLeadAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLeadDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLeadDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLeadDto" } } }, "required": true, "x-bodyName": "lead" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Leads/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single Lead record for a given Unique Id.", "description": "This endpoint retrieves a Lead based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLeads_GetLeadAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single Lead record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeads_DeleteLeadAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadSalesPeople": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing LeadSalesPeople according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLeadSalesPeople_GetAllLeadSalesPersonAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadSalesPersonDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadSalesPersonDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadSalesPersonDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLeadSalesPersonDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single LeadSalesPerson record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadSalesPeople_PutLeadSalesPersonAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLeadSalesPersonDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLeadSalesPersonDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLeadSalesPersonDto" } } }, "required": true, "x-bodyName": "leadSalesPerson" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LeadSalesPeople/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single LeadSalesPerson record for a given Unique Id.", "description": "This endpoint retrieves a LeadSalesPerson based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLeadSalesPeople_GetLeadSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single LeadSalesPerson record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLeadSalesPeople_DeleteLeadSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLeadSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MarketingPrograms": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing MarketingPrograms according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMarketingPrograms_GetAllMarketingProgramAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMarketingProgramDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMarketingProgramDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMarketingProgramDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMarketingProgramDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single MarketingProgram record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMarketingPrograms_PutMarketingProgramAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMarketingProgramDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMarketingProgramDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMarketingProgramDto" } } }, "required": true, "x-bodyName": "marketingProgram" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MarketingPrograms/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single MarketingProgram record for a given Unique Id.", "description": "This endpoint retrieves a MarketingProgram based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMarketingPrograms_GetMarketingProgramAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single MarketingProgram record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMarketingPrograms_DeleteMarketingProgramAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMarketingProgramDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Milestones": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing Milestones according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMilestones_GetAllMilestoneAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMilestoneDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMilestoneDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMilestoneDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMilestoneDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single Milestone record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMilestones_PutMilestoneAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMilestoneDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMilestoneDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMilestoneDto" } } }, "required": true, "x-bodyName": "milestone" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Milestones/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single Milestone record for a given Unique Id.", "description": "This endpoint retrieves a Milestone based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMilestones_GetMilestoneAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single Milestone record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMilestones_DeleteMilestoneAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMilestoneDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationContactGroupLinks": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing OrganizationContactGroupLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizationContactGroupLinks_GetAllOrganizationContactGroupLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactGroupLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactGroupLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactGroupLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactGroupLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single OrganizationContactGroupLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationContactGroupLinks_PutOrganizationContactGroupLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationContactGroupLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationContactGroupLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationContactGroupLinkDto" } } }, "required": true, "x-bodyName": "organizationContactGroupLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationContactGroupLinks/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single OrganizationContactGroupLink record for a given Unique Id.", "description": "This endpoint retrieves a OrganizationContactGroupLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizationContactGroupLinks_GetOrganizationContactGroupLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single OrganizationContactGroupLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationContactGroupLinks_DeleteOrganizationContactGroupLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationContacts": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing OrganizationContacts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizationContacts_GetAllOrganizationContactAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationContactDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single OrganizationContact record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationContacts_PutOrganizationContactAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationContactDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationContactDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationContactDto" } } }, "required": true, "x-bodyName": "organizationContact" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationContacts/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single OrganizationContact record for a given Unique Id.", "description": "This endpoint retrieves a OrganizationContact based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizationContacts_GetOrganizationContactAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single OrganizationContact record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationContacts_DeleteOrganizationContactAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationContactDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationIndustryTypeLinks": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing OrganizationIndustryTypeLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizationIndustryTypeLinks_GetAllOrganizationIndustryTypeLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationIndustryTypeLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationIndustryTypeLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationIndustryTypeLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationIndustryTypeLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single OrganizationIndustryTypeLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationIndustryTypeLinks_PutOrganizationIndustryTypeLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationIndustryTypeLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationIndustryTypeLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationIndustryTypeLinkDto" } } }, "required": true, "x-bodyName": "organizationIndustryTypeLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationIndustryTypeLinks/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single OrganizationIndustryTypeLink record for a given Unique Id.", "description": "This endpoint retrieves a OrganizationIndustryTypeLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizationIndustryTypeLinks_GetOrganizationIndustryTypeLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single OrganizationIndustryTypeLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationIndustryTypeLinks_DeleteOrganizationIndustryTypeLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationLocations": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing OrganizationLocations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizationLocations_GetAllOrganizationLocationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single OrganizationLocation record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationLocations_PutOrganizationLocationAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationLocationDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationLocationDto" } } }, "required": true, "x-bodyName": "organizationLocation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationLocations/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single OrganizationLocation record for a given Unique Id.", "description": "This endpoint retrieves a OrganizationLocation based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizationLocations_GetOrganizationLocationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single OrganizationLocation record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationLocations_DeleteOrganizationLocationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationLocSalesPeople": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing OrganizationLocSalesPeople according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizationLocSalesPeople_GetAllOrganizationLocSalesPersonAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocSalesPersonDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocSalesPersonDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocSalesPersonDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationLocSalesPersonDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single OrganizationLocSalesPerson record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationLocSalesPeople_PutOrganizationLocSalesPersonAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationLocSalesPersonDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationLocSalesPersonDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationLocSalesPersonDto" } } }, "required": true, "x-bodyName": "organizationLocSalesPerson" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationLocSalesPeople/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single OrganizationLocSalesPerson record for a given Unique Id.", "description": "This endpoint retrieves a OrganizationLocSalesPerson based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizationLocSalesPeople_GetOrganizationLocSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single OrganizationLocSalesPerson record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationLocSalesPeople_DeleteOrganizationLocSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationMemos": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing OrganizationMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizationMemos_GetAllOrganizationMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single OrganizationMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationMemos_PutOrganizationMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationMemoDto" } } }, "required": true, "x-bodyName": "organizationMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/OrganizationMemos/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single OrganizationMemo record for a given Unique Id.", "description": "This endpoint retrieves a OrganizationMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizationMemos_GetOrganizationMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single OrganizationMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizationMemos_DeleteOrganizationMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Organizations": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing Organizations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPOrganizations_GetAllOrganizationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPOrganizationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single Organization record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizations_PutOrganizationAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPOrganizationDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPOrganizationDto" } } }, "required": true, "x-bodyName": "organization" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Organizations/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single Organization record for a given Unique Id.", "description": "This endpoint retrieves a Organization based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPOrganizations_GetOrganizationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single Organization record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPOrganizations_DeleteOrganizationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPOrganizationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractLines": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ServiceContractLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPServiceContractLines_GetAllServiceContractLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ServiceContractLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContractLines_PutServiceContractLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPServiceContractLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractLineDto" } } }, "required": true, "x-bodyName": "serviceContractLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractLines/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ServiceContractLine record for a given Unique Id.", "description": "This endpoint retrieves a ServiceContractLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPServiceContractLines_GetServiceContractLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ServiceContractLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContractLines_DeleteServiceContractLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractMemos": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ServiceContractMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPServiceContractMemos_GetAllServiceContractMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ServiceContractMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContractMemos_PutServiceContractMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPServiceContractMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractMemoDto" } } }, "required": true, "x-bodyName": "serviceContractMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractMemos/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ServiceContractMemo record for a given Unique Id.", "description": "This endpoint retrieves a ServiceContractMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPServiceContractMemos_GetServiceContractMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ServiceContractMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContractMemos_DeleteServiceContractMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractOwners": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ServiceContractOwners according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPServiceContractOwners_GetAllServiceContractOwnerAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractOwnerDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractOwnerDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractOwnerDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractOwnerDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ServiceContractOwner record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContractOwners_PutServiceContractOwnerAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPServiceContractOwnerDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractOwnerDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractOwnerDto" } } }, "required": true, "x-bodyName": "serviceContractOwner" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractOwners/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ServiceContractOwner record for a given Unique Id.", "description": "This endpoint retrieves a ServiceContractOwner based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPServiceContractOwners_GetServiceContractOwnerAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ServiceContractOwner record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContractOwners_DeleteServiceContractOwnerAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractOwnerDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContracts": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ServiceContracts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPServiceContracts_GetAllServiceContractAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single ServiceContract record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContracts_PutServiceContractAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPServiceContractDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPServiceContractDto" } } }, "required": true, "x-bodyName": "serviceContract" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContracts/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ServiceContract record for a given Unique Id.", "description": "This endpoint retrieves a ServiceContract based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPServiceContracts_GetServiceContractAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single ServiceContract record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPServiceContracts_DeleteServiceContractAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractTypes": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing ServiceContractTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPServiceContractTypes_GetAllServiceContractTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPServiceContractTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ServiceContractTypes/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single ServiceContractType record for a given Unique Id.", "description": "This endpoint retrieves a ServiceContractType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPServiceContractTypes_GetServiceContractTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPServiceContractTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SupplierRatings": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns all existing SupplierRatings according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSupplierRatings_GetAllSupplierRatingAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSupplierRatingDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSupplierRatingDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSupplierRatingDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSupplierRatingDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CRM" ], "summary": "Creates or updates a single SupplierRating record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSupplierRatings_PutSupplierRatingAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSupplierRatingDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSupplierRatingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSupplierRatingDto" } } }, "required": true, "x-bodyName": "supplierRating" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SupplierRatings/{key}": { "get": { "tags": [ "ERP/CRM" ], "summary": "Returns a single SupplierRating record for a given Unique Id.", "description": "This endpoint retrieves a SupplierRating based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSupplierRatings_GetSupplierRatingAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CRM" ], "summary": "Deletes a single SupplierRating record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSupplierRatings_DeleteSupplierRatingAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSupplierRatingDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CustomTables/{tableName}": { "get": { "tags": [ "ERP/CUSTOM" ], "summary": "Returns all existing records from the specified M1 custom table with pagination.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1UserDefinedCustomField[operator]value. eg. `uctCustomTableFieldID[eq]TEST`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1UserDefinedCustomField[Asc],M1UserDefinedCustomField[Desc]. eg. `uctCustomTableFieldID[Asc],uctCustomTableField2ID[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nThe M1 custom table passed must exist in the M1 Data Dictionary. If the table does not exist, a 404 Not Found response will be returned.\r\n\r\nThe M1 custom table must have a field in the format of `uctUniqueID' of type unique identifier (guid). If the table does not have a unique identifier field, a 400 Bad Request response will be returned.\r\n\r\nThe M1 custom table must have a prefix defined in the M1 Data Dictionary. If the table does not have a prefix, a 400 Bad Request response will be returned.", "operationId": "ERPCustomTables_GetAllCustomTableAsync", "parameters": [ { "name": "tableName", "in": "path", "description": "The M1 Custom table name.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1UserDefinedCustomField[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1UserDefinedCustomField[Asc],M1UserDefinedCustomField[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomTableDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomTableDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomTableDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomTableDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/CUSTOM" ], "summary": "Creates or updates a single CustomTable record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing.\r\n\r\nThe M1 custom table passed must exist in the M1 Data Dictionary. If the table does not exist, a 404 Not Found response will be returned.\r\n\r\nThe M1 custom table must have a field in the format of `uctUniqueID' of type unique identifier (guid). If the table does not have a unique identifier field, a 400 Bad Request response will be returned.\r\n\r\nThe M1 custom table must have a prefix defined in the M1 Data Dictionary. If the table does not have a prefix, a 400 Bad Request response will be returned.", "operationId": "ERPCustomTables_PutCustomTableAsync", "parameters": [ { "name": "tableName", "in": "path", "description": "The custom table name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The fully populated CustomTable model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCustomTableDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCustomTableDto" } } }, "required": true, "x-bodyName": "customTable" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CustomTables/{tableName}/{key}": { "get": { "tags": [ "ERP/CUSTOM" ], "summary": "Returns a single CustomTable record for a given CustomTable Unique Id.", "description": "This endpoint retrieves a CustomTable record based on its identifier. If the record does not exist, a 404 Not Found response will be returned.\r\n\r\nThe M1 custom table passed must exist in the M1 Data Dictionary. If the table does not exist, a 404 Not Found response will be returned.\r\n\r\nThe M1 custom table must have a field in the format of `uctUniqueID' of type unique identifier (guid). If the table does not have a unique identifier field, a 400 Bad Request response will be returned.\r\n\r\nThe M1 custom table must have a prefix defined in the M1 Data Dictionary. If the table does not have a prefix, a 400 Bad Request response will be returned.", "operationId": "ERPCustomTables_GetCustomTableAsync", "parameters": [ { "name": "tableName", "in": "path", "description": "The M1 custom table name", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/CUSTOM" ], "summary": "Deletes a single CustomTable record.", "description": "If the CustomTable record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the CustomTable record is successfully deleted, a 200 OK response will be returned.\r\n\r\nThe M1 custom table passed must exist in the M1 Data Dictionary. If the table does not exist, a 404 Not Found response will be returned.\r\n\r\nThe M1 custom table must have a field in the format of `uctUniqueID' of type unique identifier (guid). If the table does not have a unique identifier field, a 400 Bad Request response will be returned.\r\n\r\nThe M1 custom table must have a prefix defined in the M1 Data Dictionary. If the table does not have a prefix, a 400 Bad Request response will be returned.\r\n\r\nIf the CustomTable UniqueID is being used anywhere in the M1 system as a foreign key (ie. DDRelations), a 400 Bad Request response will be returned.", "operationId": "ERPCustomTables_DeleteCustomTableAsync", "parameters": [ { "name": "tableName", "in": "path", "description": "The custom table name", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomTableDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Expenses": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns all existing Expenses according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPExpenses_GetAllExpenseAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Creates or updates a single Expense record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPExpenses_PutExpenseAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPExpenseDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPExpenseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPExpenseDto" } } }, "required": true, "x-bodyName": "expense" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Expenses/{key}": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns a single Expense record for a given Unique Id.", "description": "This endpoint retrieves a Expense based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPExpenses_GetExpenseAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Deletes a single Expense record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPExpenses_DeleteExpenseAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/IndirectLaborCodes": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns all existing IndirectLaborCodes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPIndirectLaborCodes_GetAllIndirectLaborCodeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndirectLaborCodeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndirectLaborCodeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndirectLaborCodeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIndirectLaborCodeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Creates or updates a single IndirectLaborCode record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPIndirectLaborCodes_PutIndirectLaborCodeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPIndirectLaborCodeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPIndirectLaborCodeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPIndirectLaborCodeDto" } } }, "required": true, "x-bodyName": "indirectLaborCode" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/IndirectLaborCodes/{key}": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns a single IndirectLaborCode record for a given Unique Id.", "description": "This endpoint retrieves a IndirectLaborCode based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPIndirectLaborCodes_GetIndirectLaborCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Deletes a single IndirectLaborCode record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPIndirectLaborCodes_DeleteIndirectLaborCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIndirectLaborCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TimecardLines": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns all existing TimecardLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTimecardLines_GetAllTimecardLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Creates or updates a single TimecardLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTimecardLines_PutTimecardLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPTimecardLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPTimecardLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPTimecardLineDto" } } }, "required": true, "x-bodyName": "timecardLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TimecardLines/{key}": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns a single TimecardLine record for a given Unique Id.", "description": "This endpoint retrieves a TimecardLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTimecardLines_GetTimecardLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Deletes a single TimecardLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTimecardLines_DeleteTimecardLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Timecards": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns all existing Timecards according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTimecards_GetAllTimecardAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTimecardDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Creates or updates a single Timecard record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTimecards_PutTimecardAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPTimecardDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPTimecardDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPTimecardDto" } } }, "required": true, "x-bodyName": "timecard" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Timecards/{key}": { "get": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Returns a single Timecard record for a given Unique Id.", "description": "This endpoint retrieves a Timecard based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTimecards_GetTimecardAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Deletes a single Timecard record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTimecards_DeleteTimecardAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTimecardDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Timecards/Batch": { "post": { "tags": [ "ERP/DATACOLLECTION" ], "summary": "Submits a timecard record in batch mode for processing by the ERP system.", "description": "This endpoint receives timecard information and enqueues it into the `InternetTransactionQueue` (ITQ) table.\r\n\r\nAfter being saved, a background worker will later pick up the ITQ record and process it asynchronously,\r\napplying additional business logic and persisting the data in the ERP system.\r\n\r\nThe payload must include a valid employee ID, timecard date, shift ID, and a list of one or more timecard lines.\r\nEach line should describe job-related information including process and work center details.\r\n\r\n### Authorization:\r\nA valid API key with write access is required to use this endpoint.", "operationId": "ERPTimecards_BatchTimecardAsync", "requestBody": { "description": "The timecard data submitted from the Integration Engine.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/MesTimecardDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MesTimecardDto" } } }, "required": true, "x-bodyName": "timecard" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "type": "object" } }, "application/json": { "schema": { "type": "object" } }, "application/xml": { "schema": { "type": "object" } }, "text/xml": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[MesIntegrationTransactionQueueInformationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[MesIntegrationTransactionQueueInformationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[MesIntegrationTransactionQueueInformationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[MesIntegrationTransactionQueueInformationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AttachmentMemos": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns all existing AttachmentMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAttachmentMemos_GetAllAttachmentMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Creates or updates a single AttachmentMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAttachmentMemos_PutAttachmentMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAttachmentMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAttachmentMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAttachmentMemoDto" } } }, "required": true, "x-bodyName": "attachmentMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AttachmentMemos/{key}": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns a single AttachmentMemo record for a given Unique Id.", "description": "This endpoint retrieves a AttachmentMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAttachmentMemos_GetAttachmentMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Deletes a single AttachmentMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAttachmentMemos_DeleteAttachmentMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Attachments": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns all existing Attachments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAttachments_GetAllAttachmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Creates or updates a single Attachment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAttachments_PutAttachmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAttachmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAttachmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAttachmentDto" } } }, "required": true, "x-bodyName": "attachment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Attachments/{key}": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns a single Attachment record for a given Unique Id.", "description": "This endpoint retrieves a Attachment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAttachments_GetAttachmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Deletes a single Attachment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAttachments_DeleteAttachmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AttachmentTypes": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns all existing AttachmentTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAttachmentTypes_GetAllAttachmentTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAttachmentTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Creates or updates a single AttachmentType record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAttachmentTypes_PutAttachmentTypeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAttachmentTypeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAttachmentTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAttachmentTypeDto" } } }, "required": true, "x-bodyName": "attachmentType" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AttachmentTypes/{key}": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns a single AttachmentType record for a given Unique Id.", "description": "This endpoint retrieves a AttachmentType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAttachmentTypes_GetAttachmentTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Deletes a single AttachmentType record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAttachmentTypes_DeleteAttachmentTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAttachmentTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DocumentLinks": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns all existing DocumentLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDocumentLinks_GetAllDocumentLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDocumentLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDocumentLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDocumentLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDocumentLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Creates or updates a single DocumentLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDocumentLinks_PutDocumentLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDocumentLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDocumentLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDocumentLinkDto" } } }, "required": true, "x-bodyName": "documentLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DocumentLinks/{key}": { "get": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Returns a single DocumentLink record for a given Unique Id.", "description": "This endpoint retrieves a DocumentLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDocumentLinks_GetDocumentLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/DOCUMENTS" ], "summary": "Deletes a single DocumentLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDocumentLinks_DeleteDocumentLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDocumentLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeAttachments": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeAttachments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeAttachments_GetAllEmployeeAttachmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeAttachmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeAttachmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeAttachmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeAttachmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single EmployeeAttachment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeAttachments_PutEmployeeAttachmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeeAttachmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeAttachmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeAttachmentDto" } } }, "required": true, "x-bodyName": "employeeAttachment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeAttachments/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeAttachment record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeAttachment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeAttachments_GetEmployeeAttachmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single EmployeeAttachment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeAttachments_DeleteEmployeeAttachmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeAttachmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeMemos": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeMemos_GetAllEmployeeMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single EmployeeMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeMemos_PutEmployeeMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeeMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeMemoDto" } } }, "required": true, "x-bodyName": "employeeMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeMemos/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeMemo record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeMemos_GetEmployeeMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single EmployeeMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeMemos_DeleteEmployeeMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeePersonalData": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeePersonalData according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeePersonalData_GetAllEmployeePersonalDatumAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePersonalDatumDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePersonalDatumDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePersonalDatumDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePersonalDatumDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single EmployeePersonalDatum record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeePersonalData_PutEmployeePersonalDatumAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeePersonalDatumDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeePersonalDatumDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeePersonalDatumDto" } } }, "required": true, "x-bodyName": "employeePersonalDatum" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeePersonalData/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeePersonalDatum record for a given Unique Id.", "description": "This endpoint retrieves a EmployeePersonalDatum based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeePersonalData_GetEmployeePersonalDatumAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single EmployeePersonalDatum record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeePersonalData_DeleteEmployeePersonalDatumAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePersonalDatumDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeePOApprovals": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeePOApprovals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeePOApprovals_GetAllEmployeePOApprovalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePOApprovalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePOApprovalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePOApprovalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeePOApprovalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single EmployeePOApproval record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeePOApprovals_PutEmployeePOApprovalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeePOApprovalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeePOApprovalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeePOApprovalDto" } } }, "required": true, "x-bodyName": "employeePOApproval" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeePOApprovals/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeePOApproval record for a given Unique Id.", "description": "This endpoint retrieves a EmployeePOApproval based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeePOApprovals_GetEmployeePOApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single EmployeePOApproval record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeePOApprovals_DeleteEmployeePOApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeePOApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeQAApprovals": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeQAApprovals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeQAApprovals_GetAllEmployeeQAApprovalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeQAApprovalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeQAApprovalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeQAApprovalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeQAApprovalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single EmployeeQAApproval record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeQAApprovals_PutEmployeeQAApprovalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeeQAApprovalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeQAApprovalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeQAApprovalDto" } } }, "required": true, "x-bodyName": "employeeQAApproval" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeQAApprovals/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeQAApproval record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeQAApproval based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeQAApprovals_GetEmployeeQAApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single EmployeeQAApproval record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeQAApprovals_DeleteEmployeeQAApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeQAApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Employees": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing Employees according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployees_GetAllEmployeeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single Employee record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployees_PutEmployeeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeDto" } } }, "required": true, "x-bodyName": "employee" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Employees/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single Employee record for a given Unique Id.", "description": "This endpoint retrieves a Employee based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployees_GetEmployeeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single Employee record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployees_DeleteEmployeeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSalesBudgetLines": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeSalesBudgetLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeSalesBudgetLines_GetAllEmployeeSalesBudgetLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSalesBudgetLines/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeSalesBudgetLine record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeSalesBudgetLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeSalesBudgetLines_GetEmployeeSalesBudgetLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSalesBudgets": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeSalesBudgets according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeSalesBudgets_GetAllEmployeeSalesBudgetAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSalesBudgets/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeSalesBudget record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeSalesBudget based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeSalesBudgets_GetEmployeeSalesBudgetAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSalesBudgetDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSkillCompetencies": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeSkillCompetencies according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeSkillCompetencies_GetAllEmployeeSkillCompetencyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillCompetencyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillCompetencyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillCompetencyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillCompetencyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSkillCompetencies/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeSkillCompetency record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeSkillCompetency based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeSkillCompetencies_GetEmployeeSkillCompetencyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillCompetencyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillCompetencyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillCompetencyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillCompetencyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSkills": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeSkills according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeSkills_GetAllEmployeeSkillAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSkillDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSkills/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeSkill record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeSkill based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeSkills_GetEmployeeSkillAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSkillDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSOApprovals": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing EmployeeSOApprovals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPEmployeeSOApprovals_GetAllEmployeeSOApprovalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSOApprovalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSOApprovalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSOApprovalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPEmployeeSOApprovalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Creates or updates a single EmployeeSOApproval record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeSOApprovals_PutEmployeeSOApprovalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPEmployeeSOApprovalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeSOApprovalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPEmployeeSOApprovalDto" } } }, "required": true, "x-bodyName": "employeeSOApproval" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/EmployeeSOApprovals/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single EmployeeSOApproval record for a given Unique Id.", "description": "This endpoint retrieves a EmployeeSOApproval based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPEmployeeSOApprovals_GetEmployeeSOApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Deletes a single EmployeeSOApproval record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPEmployeeSOApprovals_DeleteEmployeeSOApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPEmployeeSOApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShiftBreaks": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing ShiftBreaks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShiftBreaks_GetAllShiftBreakAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftBreakDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftBreakDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftBreakDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftBreakDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShiftBreaks/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single ShiftBreak record for a given Unique Id.", "description": "This endpoint retrieves a ShiftBreak based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShiftBreaks_GetShiftBreakAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftBreakDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftBreakDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftBreakDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftBreakDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Shifts": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing Shifts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShifts_GetAllShiftAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShiftDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Shifts/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single Shift record for a given Unique Id.", "description": "This endpoint retrieves a Shift based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShifts_GetShiftAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShiftDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SkillCompetencies": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing SkillCompetencies according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSkillCompetencies_GetAllSkillCompetencyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillCompetencyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillCompetencyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillCompetencyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillCompetencyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SkillCompetencies/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single SkillCompetency record for a given Unique Id.", "description": "This endpoint retrieves a SkillCompetency based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSkillCompetencies_GetSkillCompetencyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillCompetencyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillCompetencyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillCompetencyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillCompetencyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Skills": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing Skills according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSkills_GetAllSkillAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSkillDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Skills/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single Skill record for a given Unique Id.", "description": "This endpoint retrieves a Skill based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSkills_GetSkillAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSkillDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterSkillCompetencies": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing WorkCenterSkillCompetencies according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWorkCenterSkillCompetencies_GetAllWorkCenterSkillCompetencyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillCompetencyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillCompetencyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillCompetencyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillCompetencyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterSkillCompetencies/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single WorkCenterSkillCompetency record for a given Unique Id.", "description": "This endpoint retrieves a WorkCenterSkillCompetency based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWorkCenterSkillCompetencies_GetWorkCenterSkillCompetencyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillCompetencyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillCompetencyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillCompetencyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillCompetencyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterSkills": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns all existing WorkCenterSkills according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWorkCenterSkills_GetAllWorkCenterSkillAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterSkillDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterSkills/{key}": { "get": { "tags": [ "ERP/EMPLOYEE" ], "summary": "Returns a single WorkCenterSkill record for a given Unique Id.", "description": "This endpoint retrieves a WorkCenterSkill based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWorkCenterSkills_GetWorkCenterSkillAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterSkillDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AgingBuckets": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AgingBuckets according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAgingBuckets_GetAllAgingBucketAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAgingBucketDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAgingBucketDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAgingBucketDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAgingBucketDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AgingBuckets/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AgingBucket record for a given Unique Id.", "description": "This endpoint retrieves a AgingBucket based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAgingBuckets_GetAgingBucketAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAgingBucketDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAgingBucketDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAgingBucketDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAgingBucketDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoiceExpenseAccounts": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APInvoiceExpenseAccounts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPInvoiceExpenseAccounts_GetAllAPInvoiceExpenseAccountAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceExpenseAccountDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceExpenseAccountDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceExpenseAccountDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceExpenseAccountDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APInvoiceExpenseAccount record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoiceExpenseAccounts_PutAPInvoiceExpenseAccountAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPInvoiceExpenseAccountDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceExpenseAccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceExpenseAccountDto" } } }, "required": true, "x-bodyName": "aPInvoiceExpenseAccount" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoiceExpenseAccounts/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APInvoiceExpenseAccount record for a given Unique Id.", "description": "This endpoint retrieves a APInvoiceExpenseAccount based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPInvoiceExpenseAccounts_GetAPInvoiceExpenseAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APInvoiceExpenseAccount record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoiceExpenseAccounts_DeleteAPInvoiceExpenseAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoiceLines": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APInvoiceLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPInvoiceLines_GetAllAPInvoiceLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APInvoiceLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoiceLines_PutAPInvoiceLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPInvoiceLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceLineDto" } } }, "required": true, "x-bodyName": "aPInvoiceLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoiceLines/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APInvoiceLine record for a given Unique Id.", "description": "This endpoint retrieves a APInvoiceLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPInvoiceLines_GetAPInvoiceLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APInvoiceLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoiceLines_DeleteAPInvoiceLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoiceMemos": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APInvoiceMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPInvoiceMemos_GetAllAPInvoiceMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APInvoiceMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoiceMemos_PutAPInvoiceMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPInvoiceMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceMemoDto" } } }, "required": true, "x-bodyName": "aPInvoiceMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoiceMemos/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APInvoiceMemo record for a given Unique Id.", "description": "This endpoint retrieves a APInvoiceMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPInvoiceMemos_GetAPInvoiceMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APInvoiceMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoiceMemos_DeleteAPInvoiceMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoices": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APInvoices according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPInvoices_GetAllAPInvoiceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPInvoiceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APInvoice record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoices_PutAPInvoiceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPInvoiceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPInvoiceDto" } } }, "required": true, "x-bodyName": "aPInvoice" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APInvoices/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APInvoice record for a given Unique Id.", "description": "This endpoint retrieves a APInvoice based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPInvoices_GetAPInvoiceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APInvoice record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPInvoices_DeleteAPInvoiceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPInvoiceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APPaymentHeaders": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APPaymentHeaders according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPPaymentHeaders_GetAllAPPaymentHeaderAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentHeaderDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentHeaderDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentHeaderDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentHeaderDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APPaymentHeader record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPPaymentHeaders_PutAPPaymentHeaderAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPPaymentHeaderDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPPaymentHeaderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPPaymentHeaderDto" } } }, "required": true, "x-bodyName": "aPPaymentHeader" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APPaymentHeaders/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APPaymentHeader record for a given Unique Id.", "description": "This endpoint retrieves a APPaymentHeader based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPPaymentHeaders_GetAPPaymentHeaderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APPaymentHeader record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPPaymentHeaders_DeleteAPPaymentHeaderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APPaymentLines": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APPaymentLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPPaymentLines_GetAllAPPaymentLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APPaymentLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPPaymentLines_PutAPPaymentLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPPaymentLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPPaymentLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPPaymentLineDto" } } }, "required": true, "x-bodyName": "aPPaymentLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APPaymentLines/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APPaymentLine record for a given Unique Id.", "description": "This endpoint retrieves a APPaymentLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPPaymentLines_GetAPPaymentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APPaymentLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPPaymentLines_DeleteAPPaymentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APPaymentSessions": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing APPaymentSessions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAPPaymentSessions_GetAllAPPaymentSessionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentSessionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentSessionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentSessionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAPPaymentSessionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single APPaymentSession record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPPaymentSessions_PutAPPaymentSessionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAPPaymentSessionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAPPaymentSessionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAPPaymentSessionDto" } } }, "required": true, "x-bodyName": "aPPaymentSession" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/APPaymentSessions/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single APPaymentSession record for a given Unique Id.", "description": "This endpoint retrieves a APPaymentSession based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAPPaymentSessions_GetAPPaymentSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single APPaymentSession record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAPPaymentSessions_DeleteAPPaymentSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAPPaymentSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoiceLines": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARInvoiceLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARInvoiceLines_GetAllARInvoiceLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARInvoiceLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoiceLines_PutARInvoiceLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARInvoiceLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceLineDto" } } }, "required": true, "x-bodyName": "aRInvoiceLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoiceLines/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARInvoiceLine record for a given Unique Id.", "description": "This endpoint retrieves a ARInvoiceLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARInvoiceLines_GetARInvoiceLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARInvoiceLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoiceLines_DeleteARInvoiceLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoiceMemos": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARInvoiceMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARInvoiceMemos_GetAllARInvoiceMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARInvoiceMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoiceMemos_PutARInvoiceMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARInvoiceMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceMemoDto" } } }, "required": true, "x-bodyName": "aRInvoiceMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoiceMemos/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARInvoiceMemo record for a given Unique Id.", "description": "This endpoint retrieves a ARInvoiceMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARInvoiceMemos_GetARInvoiceMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARInvoiceMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoiceMemos_DeleteARInvoiceMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoices": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARInvoices according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARInvoices_GetAllARInvoiceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARInvoice record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoices_PutARInvoiceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARInvoiceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceDto" } } }, "required": true, "x-bodyName": "aRInvoice" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoices/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARInvoice record for a given Unique Id.", "description": "This endpoint retrieves a ARInvoice based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARInvoices_GetARInvoiceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARInvoice record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoices_DeleteARInvoiceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoiceSalesPeople": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARInvoiceSalesPeople according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARInvoiceSalesPeople_GetAllARInvoiceSalesPersonAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceSalesPersonDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceSalesPersonDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceSalesPersonDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARInvoiceSalesPersonDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARInvoiceSalesPerson record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoiceSalesPeople_PutARInvoiceSalesPersonAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARInvoiceSalesPersonDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceSalesPersonDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARInvoiceSalesPersonDto" } } }, "required": true, "x-bodyName": "aRInvoiceSalesPerson" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARInvoiceSalesPeople/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARInvoiceSalesPerson record for a given Unique Id.", "description": "This endpoint retrieves a ARInvoiceSalesPerson based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARInvoiceSalesPeople_GetARInvoiceSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARInvoiceSalesPerson record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARInvoiceSalesPeople_DeleteARInvoiceSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARPaymentHeaders": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARPaymentHeaders according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARPaymentHeaders_GetAllARPaymentHeaderAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentHeaderDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentHeaderDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentHeaderDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentHeaderDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARPaymentHeader record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARPaymentHeaders_PutARPaymentHeaderAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARPaymentHeaderDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARPaymentHeaderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARPaymentHeaderDto" } } }, "required": true, "x-bodyName": "aRPaymentHeader" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARPaymentHeaders/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARPaymentHeader record for a given Unique Id.", "description": "This endpoint retrieves a ARPaymentHeader based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARPaymentHeaders_GetARPaymentHeaderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARPaymentHeader record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARPaymentHeaders_DeleteARPaymentHeaderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARPaymentLines": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARPaymentLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARPaymentLines_GetAllARPaymentLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARPaymentLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARPaymentLines_PutARPaymentLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARPaymentLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARPaymentLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARPaymentLineDto" } } }, "required": true, "x-bodyName": "aRPaymentLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARPaymentLines/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARPaymentLine record for a given Unique Id.", "description": "This endpoint retrieves a ARPaymentLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARPaymentLines_GetARPaymentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARPaymentLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARPaymentLines_DeleteARPaymentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARPaymentSessions": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ARPaymentSessions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPARPaymentSessions_GetAllARPaymentSessionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentSessionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentSessionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentSessionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPARPaymentSessionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ARPaymentSession record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARPaymentSessions_PutARPaymentSessionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPARPaymentSessionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPARPaymentSessionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPARPaymentSessionDto" } } }, "required": true, "x-bodyName": "aRPaymentSession" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ARPaymentSessions/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ARPaymentSession record for a given Unique Id.", "description": "This endpoint retrieves a ARPaymentSession based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPARPaymentSessions_GetARPaymentSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ARPaymentSession record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPARPaymentSessions_DeleteARPaymentSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPARPaymentSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetAdjustments": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetAdjustments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetAdjustments_GetAllAssetAdjustmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetAdjustmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetAdjustmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetAdjustmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetAdjustmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single AssetAdjustment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetAdjustments_PutAssetAdjustmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAssetAdjustmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAssetAdjustmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAssetAdjustmentDto" } } }, "required": true, "x-bodyName": "assetAdjustment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetAdjustments/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetAdjustment record for a given Unique Id.", "description": "This endpoint retrieves a AssetAdjustment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetAdjustments_GetAssetAdjustmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single AssetAdjustment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetAdjustments_DeleteAssetAdjustmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetAdjustmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetLowValuePool": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetLowValuePool according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetLowValuePool_GetAllAssetLowValuePoolAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetLowValuePoolDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetLowValuePoolDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetLowValuePoolDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetLowValuePoolDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single AssetLowValuePool record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetLowValuePool_PutAssetLowValuePoolAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAssetLowValuePoolDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAssetLowValuePoolDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAssetLowValuePoolDto" } } }, "required": true, "x-bodyName": "assetLowValuePool" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetLowValuePool/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetLowValuePool record for a given Unique Id.", "description": "This endpoint retrieves a AssetLowValuePool based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetLowValuePool_GetAssetLowValuePoolAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single AssetLowValuePool record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetLowValuePool_DeleteAssetLowValuePoolAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetLowValuePoolDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetMemos": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetMemos_GetAllAssetMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single AssetMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetMemos_PutAssetMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAssetMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAssetMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAssetMemoDto" } } }, "required": true, "x-bodyName": "assetMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetMemos/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetMemo record for a given Unique Id.", "description": "This endpoint retrieves a AssetMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetMemos_GetAssetMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single AssetMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetMemos_DeleteAssetMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetPoolTransactions": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetPoolTransactions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetPoolTransactions_GetAllAssetPoolTransactionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetPoolTransactionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetPoolTransactionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetPoolTransactionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetPoolTransactionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single AssetPoolTransaction record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetPoolTransactions_PutAssetPoolTransactionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAssetPoolTransactionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAssetPoolTransactionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAssetPoolTransactionDto" } } }, "required": true, "x-bodyName": "assetPoolTransaction" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetPoolTransactions/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetPoolTransaction record for a given Unique Id.", "description": "This endpoint retrieves a AssetPoolTransaction based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetPoolTransactions_GetAssetPoolTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single AssetPoolTransaction record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetPoolTransactions_DeleteAssetPoolTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetPoolTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Assets": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing Assets according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssets_GetAllAssetAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single Asset record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssets_PutAssetAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAssetDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAssetDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAssetDto" } } }, "required": true, "x-bodyName": "asset" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Assets/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single Asset record for a given Unique Id.", "description": "This endpoint retrieves a Asset based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssets_GetAssetAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single Asset record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssets_DeleteAssetAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetSchedules": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetSchedules according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetSchedules_GetAllAssetScheduleAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetScheduleDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetScheduleDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetScheduleDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetScheduleDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single AssetSchedule record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetSchedules_PutAssetScheduleAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPAssetScheduleDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPAssetScheduleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPAssetScheduleDto" } } }, "required": true, "x-bodyName": "assetSchedule" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetSchedules/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetSchedule record for a given Unique Id.", "description": "This endpoint retrieves a AssetSchedule based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetSchedules_GetAssetScheduleAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single AssetSchedule record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPAssetSchedules_DeleteAssetScheduleAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetScheduleDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetTypeMethods": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetTypeMethods according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetTypeMethods_GetAllAssetTypeMethodAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeMethodDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeMethodDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeMethodDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeMethodDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetTypeMethods/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetTypeMethod record for a given Unique Id.", "description": "This endpoint retrieves a AssetTypeMethod based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetTypeMethods_GetAssetTypeMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetTypePlants": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetTypePlants according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetTypePlants_GetAllAssetTypePlantAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypePlantDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypePlantDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypePlantDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypePlantDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetTypePlants/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetTypePlant record for a given Unique Id.", "description": "This endpoint retrieves a AssetTypePlant based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetTypePlants_GetAssetTypePlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypePlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypePlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypePlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypePlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetTypes": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing AssetTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPAssetTypes_GetAllAssetTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPAssetTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/AssetTypes/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single AssetType record for a given Unique Id.", "description": "This endpoint retrieves a AssetType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPAssetTypes_GetAssetTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPAssetTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/BankAccounts": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing BankAccounts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPBankAccounts_GetAllBankAccountAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankAccountDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankAccountDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankAccountDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankAccountDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single BankAccount record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPBankAccounts_PutBankAccountAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPBankAccountDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPBankAccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPBankAccountDto" } } }, "required": true, "x-bodyName": "bankAccount" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/BankAccounts/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single BankAccount record for a given Unique Id.", "description": "This endpoint retrieves a BankAccount based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPBankAccounts_GetBankAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single BankAccount record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPBankAccounts_DeleteBankAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/BankEntries": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing BankEntries according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPBankEntries_GetAllBankEntryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankEntryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankEntryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankEntryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankEntryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single BankEntry record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPBankEntries_PutBankEntryAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPBankEntryDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPBankEntryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPBankEntryDto" } } }, "required": true, "x-bodyName": "bankEntry" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/BankEntries/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single BankEntry record for a given Unique Id.", "description": "This endpoint retrieves a BankEntry based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPBankEntries_GetBankEntryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single BankEntry record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPBankEntries_DeleteBankEntryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankEntryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/BankStatements": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing BankStatements according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPBankStatements_GetAllBankStatementAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankStatementDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankStatementDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankStatementDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPBankStatementDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single BankStatement record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPBankStatements_PutBankStatementAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPBankStatementDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPBankStatementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPBankStatementDto" } } }, "required": true, "x-bodyName": "bankStatement" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/BankStatements/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single BankStatement record for a given Unique Id.", "description": "This endpoint retrieves a BankStatement based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPBankStatements_GetBankStatementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single BankStatement record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPBankStatements_DeleteBankStatementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPBankStatementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ExpenseAccountSplits": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ExpenseAccountSplits according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPExpenseAccountSplits_GetAllExpenseAccountSplitAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseAccountSplitDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseAccountSplitDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseAccountSplitDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPExpenseAccountSplitDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ExpenseAccountSplit record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPExpenseAccountSplits_PutExpenseAccountSplitAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPExpenseAccountSplitDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPExpenseAccountSplitDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPExpenseAccountSplitDto" } } }, "required": true, "x-bodyName": "expenseAccountSplit" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ExpenseAccountSplits/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ExpenseAccountSplit record for a given Unique Id.", "description": "This endpoint retrieves a ExpenseAccountSplit based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPExpenseAccountSplits_GetExpenseAccountSplitAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ExpenseAccountSplit record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPExpenseAccountSplits_DeleteExpenseAccountSplitAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPExpenseAccountSplitDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLAccounts": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLAccounts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLAccounts_GetAllGLAccountAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLAccountDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLAccountDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLAccountDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLAccountDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLAccount record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLAccounts_PutGLAccountAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLAccountDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLAccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLAccountDto" } } }, "required": true, "x-bodyName": "gLAccount" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLAccounts/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLAccount record for a given Unique Id.", "description": "This endpoint retrieves a GLAccount based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLAccounts_GetGLAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLAccount record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLAccounts_DeleteGLAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLCategories": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLCategories according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLCategories_GetAllGLCategoryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLCategoryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLCategoryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLCategoryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLCategoryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLCategory record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLCategories_PutGLCategoryAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLCategoryDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLCategoryDto" } } }, "required": true, "x-bodyName": "gLCategory" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLCategories/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLCategory record for a given Unique Id.", "description": "This endpoint retrieves a GLCategory based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLCategories_GetGLCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLCategory record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLCategories_DeleteGLCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLCharts": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLCharts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLCharts_GetAllGLChartAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLChartDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLChartDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLChartDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLChartDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLChart record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLCharts_PutGLChartAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLChartDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLChartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLChartDto" } } }, "required": true, "x-bodyName": "gLChart" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLCharts/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLChart record for a given Unique Id.", "description": "This endpoint retrieves a GLChart based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLCharts_GetGLChartAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLChart record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLCharts_DeleteGLChartAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLChartDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLDepartments": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLDepartments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLDepartments_GetAllGLDepartmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDepartmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDepartmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDepartmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDepartmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLDepartment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLDepartments_PutGLDepartmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLDepartmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLDepartmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLDepartmentDto" } } }, "required": true, "x-bodyName": "gLDepartment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLDepartments/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLDepartment record for a given Unique Id.", "description": "This endpoint retrieves a GLDepartment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLDepartments_GetGLDepartmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLDepartment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLDepartments_DeleteGLDepartmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLDivisions": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLDivisions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLDivisions_GetAllGLDivisionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDivisionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDivisionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDivisionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLDivisionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLDivision record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLDivisions_PutGLDivisionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLDivisionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLDivisionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLDivisionDto" } } }, "required": true, "x-bodyName": "gLDivision" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLDivisions/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLDivision record for a given Unique Id.", "description": "This endpoint retrieves a GLDivision based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLDivisions_GetGLDivisionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLDivision record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLDivisions_DeleteGLDivisionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLDivisionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearBudgetAmounts": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYearBudgetAmounts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYearBudgetAmounts_GetAllGLFiscalYearBudgetAmountAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetAmountDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetAmountDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetAmountDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetAmountDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLFiscalYearBudgetAmount record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearBudgetAmounts_PutGLFiscalYearBudgetAmountAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLFiscalYearBudgetAmountDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetAmountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetAmountDto" } } }, "required": true, "x-bodyName": "gLFiscalYearBudgetAmount" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearBudgetAmounts/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYearBudgetAmount record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYearBudgetAmount based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYearBudgetAmounts_GetGLFiscalYearBudgetAmountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLFiscalYearBudgetAmount record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearBudgetAmounts_DeleteGLFiscalYearBudgetAmountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearBudgetHeaders": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYearBudgetHeaders according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYearBudgetHeaders_GetAllGLFiscalYearBudgetHeaderAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetHeaderDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetHeaderDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetHeaderDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetHeaderDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLFiscalYearBudgetHeader record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearBudgetHeaders_PutGLFiscalYearBudgetHeaderAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLFiscalYearBudgetHeaderDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetHeaderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetHeaderDto" } } }, "required": true, "x-bodyName": "gLFiscalYearBudgetHeader" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearBudgetHeaders/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYearBudgetHeader record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYearBudgetHeader based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYearBudgetHeaders_GetGLFiscalYearBudgetHeaderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLFiscalYearBudgetHeader record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearBudgetHeaders_DeleteGLFiscalYearBudgetHeaderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearBudgetLines": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYearBudgetLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYearBudgetLines_GetAllGLFiscalYearBudgetLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLFiscalYearBudgetLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearBudgetLines_PutGLFiscalYearBudgetLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLFiscalYearBudgetLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetLineDto" } } }, "required": true, "x-bodyName": "gLFiscalYearBudgetLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearBudgetLines/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYearBudgetLine record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYearBudgetLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYearBudgetLines_GetGLFiscalYearBudgetLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLFiscalYearBudgetLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearBudgetLines_DeleteGLFiscalYearBudgetLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearOpeningBalances": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYearOpeningBalances according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYearOpeningBalances_GetAllGLFiscalYearOpeningBalanceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearOpeningBalanceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearOpeningBalanceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearOpeningBalanceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearOpeningBalanceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearOpeningBalances/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYearOpeningBalance record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYearOpeningBalance based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYearOpeningBalances_GetGLFiscalYearOpeningBalanceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearOpeningBalanceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearOpeningBalanceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearOpeningBalanceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearOpeningBalanceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearPeriodMovements": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYearPeriodMovements according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYearPeriodMovements_GetAllGLFiscalYearPeriodMovementAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodMovementDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodMovementDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodMovementDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodMovementDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearPeriodMovements/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYearPeriodMovement record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYearPeriodMovement based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYearPeriodMovements_GetGLFiscalYearPeriodMovementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodMovementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodMovementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodMovementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodMovementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearPeriods": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYearPeriods according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYearPeriods_GetAllGLFiscalYearPeriodAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLFiscalYearPeriod record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearPeriods_PutGLFiscalYearPeriodAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLFiscalYearPeriodDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearPeriodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearPeriodDto" } } }, "required": true, "x-bodyName": "gLFiscalYearPeriod" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYearPeriods/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYearPeriod record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYearPeriod based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYearPeriods_GetGLFiscalYearPeriodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLFiscalYearPeriod record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYearPeriods_DeleteGLFiscalYearPeriodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYears": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLFiscalYears according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLFiscalYears_GetAllGLFiscalYearAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLFiscalYearDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLFiscalYear record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYears_PutGLFiscalYearAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLFiscalYearDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLFiscalYearDto" } } }, "required": true, "x-bodyName": "gLFiscalYear" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLFiscalYears/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLFiscalYear record for a given Unique Id.", "description": "This endpoint retrieves a GLFiscalYear based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLFiscalYears_GetGLFiscalYearAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLFiscalYear record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLFiscalYears_DeleteGLFiscalYearAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLFiscalYearDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLJournalLines": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLJournalLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLJournalLines_GetAllGLJournalLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLJournalLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLJournalLines_PutGLJournalLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLJournalLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLJournalLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLJournalLineDto" } } }, "required": true, "x-bodyName": "gLJournalLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLJournalLines/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLJournalLine record for a given Unique Id.", "description": "This endpoint retrieves a GLJournalLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLJournalLines_GetGLJournalLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLJournalLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLJournalLines_DeleteGLJournalLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLJournalMemos": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLJournalMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLJournalMemos_GetAllGLJournalMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLJournalMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLJournalMemos_PutGLJournalMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLJournalMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLJournalMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLJournalMemoDto" } } }, "required": true, "x-bodyName": "gLJournalMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLJournalMemos/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLJournalMemo record for a given Unique Id.", "description": "This endpoint retrieves a GLJournalMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLJournalMemos_GetGLJournalMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLJournalMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLJournalMemos_DeleteGLJournalMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLJournals": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing GLJournals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPGLJournals_GetAllGLJournalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPGLJournalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single GLJournal record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLJournals_PutGLJournalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPGLJournalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPGLJournalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPGLJournalDto" } } }, "required": true, "x-bodyName": "gLJournal" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/GLJournals/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single GLJournal record for a given Unique Id.", "description": "This endpoint retrieves a GLJournal based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPGLJournals_GetGLJournalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single GLJournal record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPGLJournals_DeleteGLJournalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPGLJournalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PaymentMethods": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing PaymentMethods according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPaymentMethods_GetAllPaymentMethodAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentMethodDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentMethodDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentMethodDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentMethodDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single PaymentMethod record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPaymentMethods_PutPaymentMethodAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPaymentMethodDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPaymentMethodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPaymentMethodDto" } } }, "required": true, "x-bodyName": "paymentMethod" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PaymentMethods/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single PaymentMethod record for a given Unique Id.", "description": "This endpoint retrieves a PaymentMethod based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPaymentMethods_GetPaymentMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single PaymentMethod record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPaymentMethods_DeletePaymentMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PaymentTerms": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing PaymentTerms according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPaymentTerms_GetAllPaymentTermAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentTermDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentTermDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentTermDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPaymentTermDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single PaymentTerm record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPaymentTerms_PutPaymentTermAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPaymentTermDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPaymentTermDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPaymentTermDto" } } }, "required": true, "x-bodyName": "paymentTerm" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PaymentTerms/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single PaymentTerm record for a given Unique Id.", "description": "This endpoint retrieves a PaymentTerm based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPaymentTerms_GetPaymentTermAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single PaymentTerm record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPaymentTerms_DeletePaymentTermAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPaymentTermDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectedPayments": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns all existing ProjectedPayments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProjectedPayments_GetAllProjectedPaymentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectedPaymentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectedPaymentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectedPaymentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectedPaymentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/FINANCIAL" ], "summary": "Creates or updates a single ProjectedPayment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectedPayments_PutProjectedPaymentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProjectedPaymentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProjectedPaymentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProjectedPaymentDto" } } }, "required": true, "x-bodyName": "projectedPayment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectedPayments/{key}": { "get": { "tags": [ "ERP/FINANCIAL" ], "summary": "Returns a single ProjectedPayment record for a given Unique Id.", "description": "This endpoint retrieves a ProjectedPayment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProjectedPayments_GetProjectedPaymentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/FINANCIAL" ], "summary": "Deletes a single ProjectedPayment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectedPayments_DeleteProjectedPaymentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectedPaymentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeLog": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing ChangeLog according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPChangeLog_GetAllChangeLogAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeLogDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeLogDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeLogDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeLogDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeLog/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single ChangeLog record for a given Unique Id.", "description": "This endpoint retrieves a ChangeLog based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPChangeLog_GetChangeLogAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeLogDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeLogDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeLogDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeLogDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CurrencyRateLines": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing CurrencyRateLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCurrencyRateLines_GetAllCurrencyRateLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single CurrencyRateLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCurrencyRateLines_PutCurrencyRateLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCurrencyRateLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCurrencyRateLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCurrencyRateLineDto" } } }, "required": true, "x-bodyName": "currencyRateLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CurrencyRateLines/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single CurrencyRateLine record for a given Unique Id.", "description": "This endpoint retrieves a CurrencyRateLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCurrencyRateLines_GetCurrencyRateLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single CurrencyRateLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCurrencyRateLines_DeleteCurrencyRateLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CurrencyRates": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing CurrencyRates according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCurrencyRates_GetAllCurrencyRateAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCurrencyRateDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single CurrencyRate record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCurrencyRates_PutCurrencyRateAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCurrencyRateDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCurrencyRateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCurrencyRateDto" } } }, "required": true, "x-bodyName": "currencyRate" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CurrencyRates/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single CurrencyRate record for a given Unique Id.", "description": "This endpoint retrieves a CurrencyRate based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCurrencyRates_GetCurrencyRateAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single CurrencyRate record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCurrencyRates_DeleteCurrencyRateAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCurrencyRateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DatasetProperties": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing DatasetProperties according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDatasetProperties_GetAllDatasetPropertyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDatasetPropertyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDatasetPropertyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDatasetPropertyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDatasetPropertyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DatasetProperties/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single DatasetProperty record for a given Unique Id.", "description": "This endpoint retrieves a DatasetProperty based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDatasetProperties_GetDatasetPropertyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDatasetPropertyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDatasetPropertyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDatasetPropertyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDatasetPropertyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FinancialProperties": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing FinancialProperties according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFinancialProperties_GetAllFinancialPropertyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFinancialPropertyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFinancialPropertyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFinancialPropertyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFinancialPropertyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FinancialProperties/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single FinancialProperty record for a given Unique Id.", "description": "This endpoint retrieves a FinancialProperty based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFinancialProperties_GetFinancialPropertyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFinancialPropertyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFinancialPropertyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFinancialPropertyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFinancialPropertyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NextIDs": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing NextIDs according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPNextIDs_GetAllNextIDAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNextIDDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNextIDDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNextIDDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNextIDDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single NextID record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNextIDs_PutNextIDAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPNextIDDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPNextIDDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPNextIDDto" } } }, "required": true, "x-bodyName": "nextID" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NextIDs/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single NextID record for a given Unique Id.", "description": "This endpoint retrieves a NextID based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPNextIDs_GetNextIDAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single NextID record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNextIDs_DeleteNextIDAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNextIDDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionProperties": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing ProductionProperties according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductionProperties_GetAllProductionPropertyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionPropertyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionPropertyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionPropertyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionPropertyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionProperties/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single ProductionProperty record for a given Unique Id.", "description": "This endpoint retrieves a ProductionProperty based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductionProperties_GetProductionPropertyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionPropertyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionPropertyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionPropertyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionPropertyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ReasonPlants": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing ReasonPlants according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPReasonPlants_GetAllReasonPlantAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonPlantDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonPlantDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonPlantDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonPlantDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ReasonPlants/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single ReasonPlant record for a given Unique Id.", "description": "This endpoint retrieves a ReasonPlant based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPReasonPlants_GetReasonPlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonPlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Reasons": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing Reasons according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPReasons_GetAllReasonAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReasonDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Reasons/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single Reason record for a given Unique Id.", "description": "This endpoint retrieves a Reason based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPReasons_GetReasonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReasonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RecentActivitiesLog": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing RecentActivitiesLog according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRecentActivitiesLog_GetAllRecentActivitiesLogAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRecentActivitiesLogDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRecentActivitiesLogDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRecentActivitiesLogDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRecentActivitiesLogDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RecentActivitiesLog/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single RecentActivitiesLog record for a given Unique Id.", "description": "This endpoint retrieves a RecentActivitiesLog based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRecentActivitiesLog_GetRecentActivitiesLogAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRecentActivitiesLogDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRecentActivitiesLogDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRecentActivitiesLogDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRecentActivitiesLogDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShippingProperties": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing ShippingProperties according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShippingProperties_GetAllShippingPropertyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPropertyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPropertyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPropertyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPropertyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShippingProperties/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single ShippingProperty record for a given Unique Id.", "description": "This endpoint retrieves a ShippingProperty based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShippingProperties_GetShippingPropertyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPropertyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPropertyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPropertyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPropertyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/StandardMessages": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing StandardMessages according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPStandardMessages_GetAllStandardMessageAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPStandardMessageDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPStandardMessageDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPStandardMessageDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPStandardMessageDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single StandardMessage record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPStandardMessages_PutStandardMessageAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPStandardMessageDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPStandardMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPStandardMessageDto" } } }, "required": true, "x-bodyName": "standardMessage" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/StandardMessages/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single StandardMessage record for a given Unique Id.", "description": "This endpoint retrieves a StandardMessage based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPStandardMessages_GetStandardMessageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single StandardMessage record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPStandardMessages_DeleteStandardMessageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPStandardMessageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TaxCodeLines": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing TaxCodeLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTaxCodeLines_GetAllTaxCodeLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single TaxCodeLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTaxCodeLines_PutTaxCodeLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPTaxCodeLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPTaxCodeLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPTaxCodeLineDto" } } }, "required": true, "x-bodyName": "taxCodeLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TaxCodeLines/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single TaxCodeLine record for a given Unique Id.", "description": "This endpoint retrieves a TaxCodeLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTaxCodeLines_GetTaxCodeLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single TaxCodeLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTaxCodeLines_DeleteTaxCodeLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TaxCodePlants": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing TaxCodePlants according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTaxCodePlants_GetAllTaxCodePlantAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodePlantDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodePlantDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodePlantDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodePlantDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single TaxCodePlant record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTaxCodePlants_PutTaxCodePlantAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPTaxCodePlantDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPTaxCodePlantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPTaxCodePlantDto" } } }, "required": true, "x-bodyName": "taxCodePlant" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TaxCodePlants/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single TaxCodePlant record for a given Unique Id.", "description": "This endpoint retrieves a TaxCodePlant based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTaxCodePlants_GetTaxCodePlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single TaxCodePlant record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTaxCodePlants_DeleteTaxCodePlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodePlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TaxCodes": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing TaxCodes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTaxCodes_GetAllTaxCodeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTaxCodeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/GENERAL" ], "summary": "Creates or updates a single TaxCode record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTaxCodes_PutTaxCodeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPTaxCodeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPTaxCodeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPTaxCodeDto" } } }, "required": true, "x-bodyName": "taxCode" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TaxCodes/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single TaxCode record for a given Unique Id.", "description": "This endpoint retrieves a TaxCode based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTaxCodes_GetTaxCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/GENERAL" ], "summary": "Deletes a single TaxCode record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTaxCodes_DeleteTaxCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTaxCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TopActivitiesLog": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns all existing TopActivitiesLog according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTopActivitiesLog_GetAllTopActivitiesLogAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTopActivitiesLogDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTopActivitiesLogDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTopActivitiesLogDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPTopActivitiesLogDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/TopActivitiesLog/{key}": { "get": { "tags": [ "ERP/GENERAL" ], "summary": "Returns a single TopActivitiesLog record for a given Unique Id.", "description": "This endpoint retrieves a TopActivitiesLog based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTopActivitiesLog_GetTopActivitiesLogAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTopActivitiesLogDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTopActivitiesLogDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTopActivitiesLogDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPTopActivitiesLogDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Health": { "get": { "tags": [ "ERP/HEALTH" ], "summary": "Returns success if connection was established.", "operationId": "ERPHealth_GetHealthCheck", "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[String]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[String]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[String]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[String]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CycleCodes": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing CycleCodes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCycleCodes_GetAllCycleCodeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCycleCodeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCycleCodeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCycleCodeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCycleCodeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single CycleCode record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCycleCodes_PutCycleCodeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCycleCodeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCycleCodeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCycleCodeDto" } } }, "required": true, "x-bodyName": "cycleCode" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CycleCodes/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single CycleCode record for a given Unique Id.", "description": "This endpoint retrieves a CycleCode based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCycleCodes_GetCycleCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single CycleCode record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCycleCodes_DeleteCycleCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCycleCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InventoryCountLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing InventoryCountLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPInventoryCountLines_GetAllInventoryCountLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single InventoryCountLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInventoryCountLines_PutInventoryCountLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPInventoryCountLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPInventoryCountLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPInventoryCountLineDto" } } }, "required": true, "x-bodyName": "inventoryCountLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InventoryCountLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single InventoryCountLine record for a given Unique Id.", "description": "This endpoint retrieves a InventoryCountLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPInventoryCountLines_GetInventoryCountLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single InventoryCountLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInventoryCountLines_DeleteInventoryCountLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InventoryCounts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing InventoryCounts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPInventoryCounts_GetAllInventoryCountAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInventoryCountDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single InventoryCount record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInventoryCounts_PutInventoryCountAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPInventoryCountDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPInventoryCountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPInventoryCountDto" } } }, "required": true, "x-bodyName": "inventoryCount" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InventoryCounts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single InventoryCount record for a given Unique Id.", "description": "This endpoint retrieves a InventoryCount based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPInventoryCounts_GetInventoryCountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single InventoryCount record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInventoryCounts_DeleteInventoryCountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInventoryCountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCostCategories": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LandedCostCategories according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLandedCostCategories_GetAllLandedCostCategoryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostCategoryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostCategoryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostCategoryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostCategoryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCostCategories/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LandedCostCategory record for a given Unique Id.", "description": "This endpoint retrieves a LandedCostCategory based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLandedCostCategories_GetLandedCostCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCostChargeDetails": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LandedCostChargeDetails according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLandedCostChargeDetails_GetAllLandedCostChargeDetailAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDetailDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDetailDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDetailDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDetailDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single LandedCostChargeDetail record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLandedCostChargeDetails_PutLandedCostChargeDetailAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLandedCostChargeDetailDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLandedCostChargeDetailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLandedCostChargeDetailDto" } } }, "required": true, "x-bodyName": "landedCostChargeDetail" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCostChargeDetails/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LandedCostChargeDetail record for a given Unique Id.", "description": "This endpoint retrieves a LandedCostChargeDetail based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLandedCostChargeDetails_GetLandedCostChargeDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single LandedCostChargeDetail record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLandedCostChargeDetails_DeleteLandedCostChargeDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCostCharges": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LandedCostCharges according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLandedCostCharges_GetAllLandedCostChargeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostChargeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single LandedCostCharge record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLandedCostCharges_PutLandedCostChargeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLandedCostChargeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLandedCostChargeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLandedCostChargeDto" } } }, "required": true, "x-bodyName": "landedCostCharge" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCostCharges/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LandedCostCharge record for a given Unique Id.", "description": "This endpoint retrieves a LandedCostCharge based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLandedCostCharges_GetLandedCostChargeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single LandedCostCharge record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLandedCostCharges_DeleteLandedCostChargeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostChargeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCosts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LandedCosts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLandedCosts_GetAllLandedCostAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLandedCostDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single LandedCost record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLandedCosts_PutLandedCostAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLandedCostDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLandedCostDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLandedCostDto" } } }, "required": true, "x-bodyName": "landedCost" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LandedCosts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LandedCost record for a given Unique Id.", "description": "This endpoint retrieves a LandedCost based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLandedCosts_GetLandedCostAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single LandedCost record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLandedCosts_DeleteLandedCostAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLandedCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LotNumbers": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LotNumbers according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLotNumbers_GetAllLotNumberAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single LotNumber record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLotNumbers_PutLotNumberAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLotNumberDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLotNumberDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLotNumberDto" } } }, "required": true, "x-bodyName": "lotNumber" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LotNumbers/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LotNumber record for a given Unique Id.", "description": "This endpoint retrieves a LotNumber based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLotNumbers_GetLotNumberAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single LotNumber record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLotNumbers_DeleteLotNumberAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LotNumberStatuses": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LotNumberStatuses according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLotNumberStatuses_GetAllLotNumberStatusAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberStatusDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberStatusDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberStatusDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberStatusDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single LotNumberStatus record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLotNumberStatuses_PutLotNumberStatusAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLotNumberStatusDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLotNumberStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLotNumberStatusDto" } } }, "required": true, "x-bodyName": "lotNumberStatus" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LotNumberStatuses/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LotNumberStatus record for a given Unique Id.", "description": "This endpoint retrieves a LotNumberStatus based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLotNumberStatuses_GetLotNumberStatusAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single LotNumberStatus record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLotNumberStatuses_DeleteLotNumberStatusAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberStatusDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LotNumberTransactions": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing LotNumberTransactions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPLotNumberTransactions_GetAllLotNumberTransactionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberTransactionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberTransactionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberTransactionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPLotNumberTransactionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single LotNumberTransaction record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLotNumberTransactions_PutLotNumberTransactionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPLotNumberTransactionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPLotNumberTransactionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPLotNumberTransactionDto" } } }, "required": true, "x-bodyName": "lotNumberTransaction" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/LotNumberTransactions/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single LotNumberTransaction record for a given Unique Id.", "description": "This endpoint retrieves a LotNumberTransaction based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPLotNumberTransactions_GetLotNumberTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single LotNumberTransaction record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPLotNumberTransactions_DeleteLotNumberTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPLotNumberTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MaterialIssueComponents": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing MaterialIssueComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMaterialIssueComponents_GetAllMaterialIssueComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single MaterialIssueComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMaterialIssueComponents_PutMaterialIssueComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMaterialIssueComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMaterialIssueComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMaterialIssueComponentDto" } } }, "required": true, "x-bodyName": "materialIssueComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MaterialIssueComponents/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single MaterialIssueComponent record for a given Unique Id.", "description": "This endpoint retrieves a MaterialIssueComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMaterialIssueComponents_GetMaterialIssueComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single MaterialIssueComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMaterialIssueComponents_DeleteMaterialIssueComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MaterialIssueLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing MaterialIssueLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMaterialIssueLines_GetAllMaterialIssueLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single MaterialIssueLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMaterialIssueLines_PutMaterialIssueLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMaterialIssueLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMaterialIssueLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMaterialIssueLineDto" } } }, "required": true, "x-bodyName": "materialIssueLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MaterialIssueLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single MaterialIssueLine record for a given Unique Id.", "description": "This endpoint retrieves a MaterialIssueLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMaterialIssueLines_GetMaterialIssueLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single MaterialIssueLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMaterialIssueLines_DeleteMaterialIssueLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MaterialIssues": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing MaterialIssues according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMaterialIssues_GetAllMaterialIssueAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMaterialIssueDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single MaterialIssue record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMaterialIssues_PutMaterialIssueAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMaterialIssueDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMaterialIssueDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMaterialIssueDto" } } }, "required": true, "x-bodyName": "materialIssue" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MaterialIssues/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single MaterialIssue record for a given Unique Id.", "description": "This endpoint retrieves a MaterialIssue based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMaterialIssues_GetMaterialIssueAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single MaterialIssue record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMaterialIssues_DeleteMaterialIssueAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMaterialIssueDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MfgReceiptComponents": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing MfgReceiptComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMfgReceiptComponents_GetAllMfgReceiptComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single MfgReceiptComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMfgReceiptComponents_PutMfgReceiptComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMfgReceiptComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMfgReceiptComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMfgReceiptComponentDto" } } }, "required": true, "x-bodyName": "mfgReceiptComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MfgReceiptComponents/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single MfgReceiptComponent record for a given Unique Id.", "description": "This endpoint retrieves a MfgReceiptComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMfgReceiptComponents_GetMfgReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single MfgReceiptComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMfgReceiptComponents_DeleteMfgReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MfgReceipts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing MfgReceipts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMfgReceipts_GetAllMfgReceiptAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMfgReceiptDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single MfgReceipt record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMfgReceipts_PutMfgReceiptAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMfgReceiptDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMfgReceiptDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMfgReceiptDto" } } }, "required": true, "x-bodyName": "mfgReceipt" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MfgReceipts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single MfgReceipt record for a given Unique Id.", "description": "This endpoint retrieves a MfgReceipt based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMfgReceipts_GetMfgReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single MfgReceipt record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMfgReceipts_DeleteMfgReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMfgReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartAlternates": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartAlternates according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartAlternates_GetAllPartAlternateAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAlternateDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAlternateDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAlternateDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAlternateDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartAlternate record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartAlternates_PutPartAlternateAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartAlternateDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartAlternateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartAlternateDto" } } }, "required": true, "x-bodyName": "partAlternate" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartAlternates/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartAlternate record for a given Unique Id.", "description": "This endpoint retrieves a PartAlternate based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartAlternates_GetPartAlternateAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartAlternate record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartAlternates_DeletePartAlternateAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAlternateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartAssemblies": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartAssemblies according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartAssemblies_GetAllPartAssemblyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAssemblyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAssemblyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAssemblyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartAssemblyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartAssembly record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartAssemblies_PutPartAssemblyAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartAssemblyDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartAssemblyDto" } } }, "required": true, "x-bodyName": "partAssembly" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartAssemblies/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartAssembly record for a given Unique Id.", "description": "This endpoint retrieves a PartAssembly based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartAssemblies_GetPartAssemblyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartAssembly record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartAssemblies_DeletePartAssemblyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartBinDetails": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartBinDetails according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartBinDetails_GetAllPartBinDetailAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDetailDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDetailDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDetailDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDetailDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartBinDetail record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartBinDetails_PutPartBinDetailAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartBinDetailDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartBinDetailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartBinDetailDto" } } }, "required": true, "x-bodyName": "partBinDetail" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartBinDetails/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartBinDetail record for a given Unique Id.", "description": "This endpoint retrieves a PartBinDetail based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartBinDetails_GetPartBinDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartBinDetail record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartBinDetails_DeletePartBinDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartBins": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartBins according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartBins_GetAllPartBinAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartBinDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartBin record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartBins_PutPartBinAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartBinDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartBinDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartBinDto" } } }, "required": true, "x-bodyName": "partBin" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartBins/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartBin record for a given Unique Id.", "description": "This endpoint retrieves a PartBin based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartBins_GetPartBinAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartBin record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartBins_DeletePartBinAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartBinDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartClasses": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartClasses according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartClasses_GetAllPartClassAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartClass record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartClasses_PutPartClassAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartClassDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartClassDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartClassDto" } } }, "required": true, "x-bodyName": "partClass" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartClasses/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartClass record for a given Unique Id.", "description": "This endpoint retrieves a PartClass based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartClasses_GetPartClassAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartClass record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartClasses_DeletePartClassAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartClassPlants": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartClassPlants according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartClassPlants_GetAllPartClassPlantAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassPlantDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassPlantDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassPlantDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartClassPlantDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartClassPlants/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartClassPlant record for a given Unique Id.", "description": "This endpoint retrieves a PartClassPlant based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartClassPlants_GetPartClassPlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartClassPlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartCrossReferences": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartCrossReferences according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartCrossReferences_GetAllPartCrossReferenceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartCrossReferenceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartCrossReferenceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartCrossReferenceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartCrossReferenceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartCrossReference record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartCrossReferences_PutPartCrossReferenceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartCrossReferenceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartCrossReferenceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartCrossReferenceDto" } } }, "required": true, "x-bodyName": "partCrossReference" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartCrossReferences/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartCrossReference record for a given Unique Id.", "description": "This endpoint retrieves a PartCrossReference based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartCrossReferences_GetPartCrossReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartCrossReference record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartCrossReferences_DeletePartCrossReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartCrossReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartForecastLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartForecastLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartForecastLines_GetAllPartForecastLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartForecastLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartForecastLines_PutPartForecastLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartForecastLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartForecastLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartForecastLineDto" } } }, "required": true, "x-bodyName": "partForecastLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartForecastLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartForecastLine record for a given Unique Id.", "description": "This endpoint retrieves a PartForecastLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartForecastLines_GetPartForecastLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartForecastLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartForecastLines_DeletePartForecastLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartForecasts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartForecasts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartForecasts_GetAllPartForecastAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartForecastDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartForecast record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartForecasts_PutPartForecastAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartForecastDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartForecastDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartForecastDto" } } }, "required": true, "x-bodyName": "partForecast" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartForecasts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartForecast record for a given Unique Id.", "description": "This endpoint retrieves a PartForecast based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartForecasts_GetPartForecastAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartForecast record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartForecasts_DeletePartForecastAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartForecastDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartGroupPlants": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartGroupPlants according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartGroupPlants_GetAllPartGroupPlantAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupPlantDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupPlantDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupPlantDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupPlantDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartGroupPlants/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartGroupPlant record for a given Unique Id.", "description": "This endpoint retrieves a PartGroupPlant based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartGroupPlants_GetPartGroupPlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupPlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartGroups": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartGroups according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartGroups_GetAllPartGroupAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartGroupDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartGroup record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartGroups_PutPartGroupAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartGroupDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartGroupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartGroupDto" } } }, "required": true, "x-bodyName": "partGroup" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartGroups/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartGroup record for a given Unique Id.", "description": "This endpoint retrieves a PartGroup based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartGroups_GetPartGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartGroup record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartGroups_DeletePartGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartMaterials": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartMaterials according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartMaterials_GetAllPartMaterialAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMaterialDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMaterialDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMaterialDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMaterialDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartMaterial record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartMaterials_PutPartMaterialAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartMaterialDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartMaterialDto" } } }, "required": true, "x-bodyName": "partMaterial" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartMaterials/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartMaterial record for a given Unique Id.", "description": "This endpoint retrieves a PartMaterial based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartMaterials_GetPartMaterialAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartMaterial record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartMaterials_DeletePartMaterialAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartMemos": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartMemos_GetAllPartMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartMemos_PutPartMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartMemoDto" } } }, "required": true, "x-bodyName": "partMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartMemos/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartMemo record for a given Unique Id.", "description": "This endpoint retrieves a PartMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartMemos_GetPartMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartMemos_DeletePartMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartOperations": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartOperations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartOperations_GetAllPartOperationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOperationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOperationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOperationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOperationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartOperation record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartOperations_PutPartOperationAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartOperationDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartOperationDto" } } }, "required": true, "x-bodyName": "partOperation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartOperations/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartOperation record for a given Unique Id.", "description": "This endpoint retrieves a PartOperation based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartOperations_GetPartOperationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartOperation record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartOperations_DeletePartOperationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartOrgReferences": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartOrgReferences according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartOrgReferences_GetAllPartOrgReferenceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOrgReferenceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOrgReferenceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOrgReferenceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartOrgReferenceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartOrgReference record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartOrgReferences_PutPartOrgReferenceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartOrgReferenceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartOrgReferenceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartOrgReferenceDto" } } }, "required": true, "x-bodyName": "partOrgReference" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartOrgReferences/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartOrgReference record for a given Unique Id.", "description": "This endpoint retrieves a PartOrgReference based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartOrgReferences_GetPartOrgReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartOrgReference record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartOrgReferences_DeletePartOrgReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartOrgReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartPriceBreaks": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartPriceBreaks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartPriceBreaks_GetAllPartPriceBreakAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceBreakDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceBreakDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceBreakDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceBreakDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartPriceBreak record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartPriceBreaks_PutPartPriceBreakAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartPriceBreakDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartPriceBreakDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartPriceBreakDto" } } }, "required": true, "x-bodyName": "partPriceBreak" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartPriceBreaks/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartPriceBreak record for a given Unique Id.", "description": "This endpoint retrieves a PartPriceBreak based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartPriceBreaks_GetPartPriceBreakAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartPriceBreak record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartPriceBreaks_DeletePartPriceBreakAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceBreakDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartPrices": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartPrices according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartPrices_GetAllPartPriceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartPriceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartPrice record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartPrices_PutPartPriceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartPriceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartPriceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartPriceDto" } } }, "required": true, "x-bodyName": "partPrice" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartPrices/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartPrice record for a given Unique Id.", "description": "This endpoint retrieves a PartPrice based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartPrices_GetPartPriceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartPrice record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartPrices_DeletePartPriceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartPriceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartRevisions": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartRevisions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartRevisions_GetAllPartRevisionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRevisionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRevisionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRevisionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartRevisionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartRevision record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartRevisions_PutPartRevisionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartRevisionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartRevisionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartRevisionDto" } } }, "required": true, "x-bodyName": "partRevision" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartRevisions/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartRevision record for a given Unique Id.", "description": "This endpoint retrieves a PartRevision based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartRevisions_GetPartRevisionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartRevision record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartRevisions_DeletePartRevisionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartRevisionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Parts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing Parts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPParts_GetAllPartAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single Part record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPParts_PutPartAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartDto" } } }, "required": true, "x-bodyName": "part" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Parts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single Part record for a given Unique Id.", "description": "This endpoint retrieves a Part based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPParts_GetPartAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single Part record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPParts_DeletePartAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartTransactionCosts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartTransactionCosts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartTransactionCosts_GetAllPartTransactionCostAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionCostDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionCostDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionCostDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionCostDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartTransactionCost record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartTransactionCosts_PutPartTransactionCostAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartTransactionCostDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartTransactionCostDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartTransactionCostDto" } } }, "required": true, "x-bodyName": "partTransactionCost" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartTransactionCosts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartTransactionCost record for a given Unique Id.", "description": "This endpoint retrieves a PartTransactionCost based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartTransactionCosts_GetPartTransactionCostAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartTransactionCost record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartTransactionCosts_DeletePartTransactionCostAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartTransactions": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartTransactions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartTransactions_GetAllPartTransactionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartTransactionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartTransaction record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartTransactions_PutPartTransactionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartTransactionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartTransactionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartTransactionDto" } } }, "required": true, "x-bodyName": "partTransaction" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartTransactions/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartTransaction record for a given Unique Id.", "description": "This endpoint retrieves a PartTransaction based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartTransactions_GetPartTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartTransaction record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartTransactions_DeletePartTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartUnitSalePrices": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartUnitSalePrices according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartUnitSalePrices_GetAllPartUnitSalePriceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartUnitSalePriceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartUnitSalePriceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartUnitSalePriceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartUnitSalePriceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartUnitSalePrice record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartUnitSalePrices_PutPartUnitSalePriceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartUnitSalePriceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartUnitSalePriceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartUnitSalePriceDto" } } }, "required": true, "x-bodyName": "partUnitSalePrice" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartUnitSalePrices/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartUnitSalePrice record for a given Unique Id.", "description": "This endpoint retrieves a PartUnitSalePrice based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartUnitSalePrices_GetPartUnitSalePriceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartUnitSalePrice record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartUnitSalePrices_DeletePartUnitSalePriceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartUnitSalePriceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartWarehouseLocations": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing PartWarehouseLocations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPartWarehouseLocations_GetAllPartWarehouseLocationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartWarehouseLocationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartWarehouseLocationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartWarehouseLocationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPartWarehouseLocationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single PartWarehouseLocation record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartWarehouseLocations_PutPartWarehouseLocationAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPartWarehouseLocationDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPartWarehouseLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPartWarehouseLocationDto" } } }, "required": true, "x-bodyName": "partWarehouseLocation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PartWarehouseLocations/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single PartWarehouseLocation record for a given Unique Id.", "description": "This endpoint retrieves a PartWarehouseLocation based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPartWarehouseLocations_GetPartWarehouseLocationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single PartWarehouseLocation record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPartWarehouseLocations_DeletePartWarehouseLocationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPartWarehouseLocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductCategories": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing ProductCategories according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductCategories_GetAllProductCategoryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductCategories/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single ProductCategory record for a given Unique Id.", "description": "This endpoint retrieves a ProductCategory based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductCategories_GetProductCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductCategoryLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing ProductCategoryLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductCategoryLines_GetAllProductCategoryLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductCategoryLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductCategoryLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single ProductCategoryLine record for a given Unique Id.", "description": "This endpoint retrieves a ProductCategoryLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductCategoryLines_GetProductCategoryLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductCategoryLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuantityAdjustments": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing QuantityAdjustments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuantityAdjustments_GetAllQuantityAdjustmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuantityAdjustmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuantityAdjustmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuantityAdjustmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuantityAdjustmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single QuantityAdjustment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuantityAdjustments_PutQuantityAdjustmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuantityAdjustmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuantityAdjustmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuantityAdjustmentDto" } } }, "required": true, "x-bodyName": "quantityAdjustment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuantityAdjustments/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single QuantityAdjustment record for a given Unique Id.", "description": "This endpoint retrieves a QuantityAdjustment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuantityAdjustments_GetQuantityAdjustmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single QuantityAdjustment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuantityAdjustments_DeleteQuantityAdjustmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuantityAdjustmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SerialNumbers": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing SerialNumbers according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSerialNumbers_GetAllSerialNumberAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single SerialNumber record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSerialNumbers_PutSerialNumberAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSerialNumberDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSerialNumberDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSerialNumberDto" } } }, "required": true, "x-bodyName": "serialNumber" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SerialNumbers/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single SerialNumber record for a given Unique Id.", "description": "This endpoint retrieves a SerialNumber based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSerialNumbers_GetSerialNumberAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single SerialNumber record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSerialNumbers_DeleteSerialNumberAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SerialNumberStatuses": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing SerialNumberStatuses according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSerialNumberStatuses_GetAllSerialNumberStatusAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberStatusDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberStatusDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberStatusDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberStatusDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single SerialNumberStatus record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSerialNumberStatuses_PutSerialNumberStatusAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSerialNumberStatusDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSerialNumberStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSerialNumberStatusDto" } } }, "required": true, "x-bodyName": "serialNumberStatus" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SerialNumberStatuses/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single SerialNumberStatus record for a given Unique Id.", "description": "This endpoint retrieves a SerialNumberStatus based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSerialNumberStatuses_GetSerialNumberStatusAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single SerialNumberStatus record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSerialNumberStatuses_DeleteSerialNumberStatusAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberStatusDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SerialNumberTransactions": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing SerialNumberTransactions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSerialNumberTransactions_GetAllSerialNumberTransactionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberTransactionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberTransactionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberTransactionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSerialNumberTransactionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single SerialNumberTransaction record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSerialNumberTransactions_PutSerialNumberTransactionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSerialNumberTransactionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSerialNumberTransactionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSerialNumberTransactionDto" } } }, "required": true, "x-bodyName": "serialNumberTransaction" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SerialNumberTransactions/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single SerialNumberTransaction record for a given Unique Id.", "description": "This endpoint retrieves a SerialNumberTransaction based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSerialNumberTransactions_GetSerialNumberTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single SerialNumberTransaction record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSerialNumberTransactions_DeleteSerialNumberTransactionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSerialNumberTransactionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseBins": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseBins according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseBins_GetAllWarehouseBinAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseBinDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseBinDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseBinDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseBinDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseBin record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseBins_PutWarehouseBinAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseBinDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseBinDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseBinDto" } } }, "required": true, "x-bodyName": "warehouseBin" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseBins/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseBin record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseBin based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseBins_GetWarehouseBinAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseBin record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseBins_DeleteWarehouseBinAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseBinDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseReceiptComponents": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseReceiptComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseReceiptComponents_GetAllWarehouseReceiptComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseReceiptComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseReceiptComponents_PutWarehouseReceiptComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseReceiptComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseReceiptComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseReceiptComponentDto" } } }, "required": true, "x-bodyName": "warehouseReceiptComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseReceiptComponents/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseReceiptComponent record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseReceiptComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseReceiptComponents_GetWarehouseReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseReceiptComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseReceiptComponents_DeleteWarehouseReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseReceiptLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseReceiptLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseReceiptLines_GetAllWarehouseReceiptLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseReceiptLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseReceiptLines_PutWarehouseReceiptLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseReceiptLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseReceiptLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseReceiptLineDto" } } }, "required": true, "x-bodyName": "warehouseReceiptLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseReceiptLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseReceiptLine record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseReceiptLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseReceiptLines_GetWarehouseReceiptLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseReceiptLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseReceiptLines_DeleteWarehouseReceiptLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseReceipts": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseReceipts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseReceipts_GetAllWarehouseReceiptAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseReceiptDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseReceipt record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseReceipts_PutWarehouseReceiptAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseReceiptDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseReceiptDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseReceiptDto" } } }, "required": true, "x-bodyName": "warehouseReceipt" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseReceipts/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseReceipt record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseReceipt based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseReceipts_GetWarehouseReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseReceipt record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseReceipts_DeleteWarehouseReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseRequisitionComponents": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseRequisitionComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseRequisitionComponents_GetAllWarehouseRequisitionComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseRequisitionComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseRequisitionComponents_PutWarehouseRequisitionComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseRequisitionComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseRequisitionComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseRequisitionComponentDto" } } }, "required": true, "x-bodyName": "warehouseRequisitionComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseRequisitionComponents/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseRequisitionComponent record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseRequisitionComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseRequisitionComponents_GetWarehouseRequisitionComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseRequisitionComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseRequisitionComponents_DeleteWarehouseRequisitionComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseRequisitionLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseRequisitionLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseRequisitionLines_GetAllWarehouseRequisitionLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseRequisitionLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseRequisitionLines_PutWarehouseRequisitionLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseRequisitionLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseRequisitionLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseRequisitionLineDto" } } }, "required": true, "x-bodyName": "warehouseRequisitionLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseRequisitionLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseRequisitionLine record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseRequisitionLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseRequisitionLines_GetWarehouseRequisitionLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseRequisitionLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseRequisitionLines_DeleteWarehouseRequisitionLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseRequisitions": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseRequisitions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseRequisitions_GetAllWarehouseRequisitionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseRequisitionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseRequisition record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseRequisitions_PutWarehouseRequisitionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseRequisitionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseRequisitionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseRequisitionDto" } } }, "required": true, "x-bodyName": "warehouseRequisition" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseRequisitions/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseRequisition record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseRequisition based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseRequisitions_GetWarehouseRequisitionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseRequisition record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseRequisitions_DeleteWarehouseRequisitionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseRequisitionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Warehouses": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing Warehouses according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouses_GetAllWarehouseAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single Warehouse record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouses_PutWarehouseAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseDto" } } }, "required": true, "x-bodyName": "warehouse" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Warehouses/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single Warehouse record for a given Unique Id.", "description": "This endpoint retrieves a Warehouse based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouses_GetWarehouseAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single Warehouse record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouses_DeleteWarehouseAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseTransferComponents": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseTransferComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseTransferComponents_GetAllWarehouseTransferComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseTransferComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseTransferComponents_PutWarehouseTransferComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseTransferComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseTransferComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseTransferComponentDto" } } }, "required": true, "x-bodyName": "warehouseTransferComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseTransferComponents/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseTransferComponent record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseTransferComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseTransferComponents_GetWarehouseTransferComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseTransferComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseTransferComponents_DeleteWarehouseTransferComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseTransferLines": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseTransferLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseTransferLines_GetAllWarehouseTransferLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseTransferLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseTransferLines_PutWarehouseTransferLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseTransferLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseTransferLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseTransferLineDto" } } }, "required": true, "x-bodyName": "warehouseTransferLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseTransferLines/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseTransferLine record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseTransferLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseTransferLines_GetWarehouseTransferLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseTransferLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseTransferLines_DeleteWarehouseTransferLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseTransfers": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns all existing WarehouseTransfers according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWarehouseTransfers_GetAllWarehouseTransferAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWarehouseTransferDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/INVENTORY" ], "summary": "Creates or updates a single WarehouseTransfer record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseTransfers_PutWarehouseTransferAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWarehouseTransferDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseTransferDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWarehouseTransferDto" } } }, "required": true, "x-bodyName": "warehouseTransfer" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WarehouseTransfers/{key}": { "get": { "tags": [ "ERP/INVENTORY" ], "summary": "Returns a single WarehouseTransfer record for a given Unique Id.", "description": "This endpoint retrieves a WarehouseTransfer based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWarehouseTransfers_GetWarehouseTransferAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/INVENTORY" ], "summary": "Deletes a single WarehouseTransfer record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWarehouseTransfers_DeleteWarehouseTransferAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWarehouseTransferDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequestGroupLinks": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ChangeRequestGroupLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPChangeRequestGroupLinks_GetAllChangeRequestGroupLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single ChangeRequestGroupLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPChangeRequestGroupLinks_PutChangeRequestGroupLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPChangeRequestGroupLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPChangeRequestGroupLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPChangeRequestGroupLinkDto" } } }, "required": true, "x-bodyName": "changeRequestGroupLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequestGroupLinks/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ChangeRequestGroupLink record for a given Unique Id.", "description": "This endpoint retrieves a ChangeRequestGroupLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPChangeRequestGroupLinks_GetChangeRequestGroupLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single ChangeRequestGroupLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPChangeRequestGroupLinks_DeleteChangeRequestGroupLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequestGroups": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ChangeRequestGroups according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPChangeRequestGroups_GetAllChangeRequestGroupAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestGroupDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequestGroups/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ChangeRequestGroup record for a given Unique Id.", "description": "This endpoint retrieves a ChangeRequestGroup based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPChangeRequestGroups_GetChangeRequestGroupAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestGroupDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequests": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ChangeRequests according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPChangeRequests_GetAllChangeRequestAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single ChangeRequest record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPChangeRequests_PutChangeRequestAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPChangeRequestDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPChangeRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPChangeRequestDto" } } }, "required": true, "x-bodyName": "changeRequest" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequests/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ChangeRequest record for a given Unique Id.", "description": "This endpoint retrieves a ChangeRequest based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPChangeRequests_GetChangeRequestAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single ChangeRequest record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPChangeRequests_DeleteChangeRequestAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequestTypes": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ChangeRequestTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPChangeRequestTypes_GetAllChangeRequestTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPChangeRequestTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single ChangeRequestType record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPChangeRequestTypes_PutChangeRequestTypeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPChangeRequestTypeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPChangeRequestTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPChangeRequestTypeDto" } } }, "required": true, "x-bodyName": "changeRequestType" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ChangeRequestTypes/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ChangeRequestType record for a given Unique Id.", "description": "This endpoint retrieves a ChangeRequestType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPChangeRequestTypes_GetChangeRequestTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single ChangeRequestType record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPChangeRequestTypes_DeleteChangeRequestTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPChangeRequestTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobAssemblies": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobAssemblies according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobAssemblies_GetAllJobAssemblyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobAssemblyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobAssemblyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobAssemblyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobAssemblyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobAssembly record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobAssemblies_PutJobAssemblyAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobAssemblyDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobAssemblyDto" } } }, "required": true, "x-bodyName": "jobAssembly" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobAssemblies/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobAssembly record for a given Unique Id.", "description": "This endpoint retrieves a JobAssembly based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobAssemblies_GetJobAssemblyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobAssembly record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobAssemblies_DeleteJobAssemblyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobCosts": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobCosts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobCosts_GetAllJobCostAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobCostDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobCostDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobCostDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobCostDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobCost record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobCosts_PutJobCostAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobCostDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobCostDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobCostDto" } } }, "required": true, "x-bodyName": "jobCost" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobCosts/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobCost record for a given Unique Id.", "description": "This endpoint retrieves a JobCost based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobCosts_GetJobCostAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobCost record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobCosts_DeleteJobCostAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobCostDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobMaterialComponents": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobMaterialComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobMaterialComponents_GetAllJobMaterialComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobMaterialComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobMaterialComponents_PutJobMaterialComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobMaterialComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobMaterialComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobMaterialComponentDto" } } }, "required": true, "x-bodyName": "jobMaterialComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobMaterialComponents/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobMaterialComponent record for a given Unique Id.", "description": "This endpoint retrieves a JobMaterialComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobMaterialComponents_GetJobMaterialComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobMaterialComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobMaterialComponents_DeleteJobMaterialComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobMaterials": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobMaterials according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobMaterials_GetAllJobMaterialAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMaterialDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobMaterial record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobMaterials_PutJobMaterialAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobMaterialDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobMaterialDto" } } }, "required": true, "x-bodyName": "jobMaterial" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobMaterials/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobMaterial record for a given Unique Id.", "description": "This endpoint retrieves a JobMaterial based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobMaterials_GetJobMaterialAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobMaterial record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobMaterials_DeleteJobMaterialAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobMemos": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobMemos_GetAllJobMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobMemos_PutJobMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobMemoDto" } } }, "required": true, "x-bodyName": "jobMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobMemos/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobMemo record for a given Unique Id.", "description": "This endpoint retrieves a JobMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobMemos_GetJobMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobMemos_DeleteJobMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobOperations": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobOperations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobOperations_GetAllJobOperationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobOperationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobOperationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobOperationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobOperationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobOperation record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobOperations_PutJobOperationAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobOperationDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobOperationDto" } } }, "required": true, "x-bodyName": "jobOperation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobOperations/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobOperation record for a given Unique Id.", "description": "This endpoint retrieves a JobOperation based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobOperations_GetJobOperationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobOperation record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobOperations_DeleteJobOperationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobPriorities": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobPriorities according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobPriorities_GetAllJobPriorityAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobPriorityDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobPriorityDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobPriorityDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobPriorityDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobPriority record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobPriorities_PutJobPriorityAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobPriorityDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobPriorityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobPriorityDto" } } }, "required": true, "x-bodyName": "jobPriority" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobPriorities/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobPriority record for a given Unique Id.", "description": "This endpoint retrieves a JobPriority based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobPriorities_GetJobPriorityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobPriority record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobPriorities_DeleteJobPriorityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobPriorityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Jobs": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing Jobs according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobs_GetAllJobAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single Job record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobs_PutJobAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobDto" } } }, "required": true, "x-bodyName": "job" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Jobs/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single Job record for a given Unique Id.", "description": "This endpoint retrieves a Job based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobs_GetJobAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single Job record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobs_DeleteJobAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobScenarios": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing JobScenarios according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPJobScenarios_GetAllJobScenarioAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobScenarioDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobScenarioDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobScenarioDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPJobScenarioDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single JobScenario record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobScenarios_PutJobScenarioAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPJobScenarioDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPJobScenarioDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPJobScenarioDto" } } }, "required": true, "x-bodyName": "jobScenario" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/JobScenarios/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single JobScenario record for a given Unique Id.", "description": "This endpoint retrieves a JobScenario based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPJobScenarios_GetJobScenarioAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single JobScenario record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPJobScenarios_DeleteJobScenarioAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPJobScenarioDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPDemands": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing MRPDemands according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMRPDemands_GetAllMRPDemandAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPDemandDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPDemandDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPDemandDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPDemandDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single MRPDemand record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPDemands_PutMRPDemandAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMRPDemandDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMRPDemandDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMRPDemandDto" } } }, "required": true, "x-bodyName": "mRPDemand" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPDemands/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single MRPDemand record for a given Unique Id.", "description": "This endpoint retrieves a MRPDemand based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMRPDemands_GetMRPDemandAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single MRPDemand record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPDemands_DeleteMRPDemandAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPDemandDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPJobDetails": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing MRPJobDetails according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMRPJobDetails_GetAllMRPJobDetailAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPJobDetailDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPJobDetailDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPJobDetailDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPJobDetailDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single MRPJobDetail record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPJobDetails_PutMRPJobDetailAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMRPJobDetailDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMRPJobDetailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMRPJobDetailDto" } } }, "required": true, "x-bodyName": "mRPJobDetail" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPJobDetails/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single MRPJobDetail record for a given Unique Id.", "description": "This endpoint retrieves a MRPJobDetail based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMRPJobDetails_GetMRPJobDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single MRPJobDetail record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPJobDetails_DeleteMRPJobDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPJobDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPLines": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing MRPLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMRPLines_GetAllMRPLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single MRPLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPLines_PutMRPLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMRPLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMRPLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMRPLineDto" } } }, "required": true, "x-bodyName": "mRPLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPLines/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single MRPLine record for a given Unique Id.", "description": "This endpoint retrieves a MRPLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMRPLines_GetMRPLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single MRPLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPLines_DeleteMRPLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPSessions": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing MRPSessions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMRPSessions_GetAllMRPSessionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSessionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSessionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSessionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSessionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single MRPSession record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPSessions_PutMRPSessionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMRPSessionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMRPSessionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMRPSessionDto" } } }, "required": true, "x-bodyName": "mRPSession" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPSessions/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single MRPSession record for a given Unique Id.", "description": "This endpoint retrieves a MRPSession based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMRPSessions_GetMRPSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single MRPSession record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPSessions_DeleteMRPSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPSupply": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing MRPSupply according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPMRPSupply_GetAllMRPSupplyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSupplyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSupplyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSupplyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPMRPSupplyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single MRPSupply record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPSupply_PutMRPSupplyAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPMRPSupplyDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPMRPSupplyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPMRPSupplyDto" } } }, "required": true, "x-bodyName": "mRPSupply" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/MRPSupply/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single MRPSupply record for a given Unique Id.", "description": "This endpoint retrieves a MRPSupply based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPMRPSupply_GetMRPSupplyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single MRPSupply record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPMRPSupply_DeleteMRPSupplyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPMRPSupplyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PlantDepartments": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing PlantDepartments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPlantDepartments_GetAllPlantDepartmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDepartmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDepartmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDepartmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDepartmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single PlantDepartment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPlantDepartments_PutPlantDepartmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPlantDepartmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPlantDepartmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPlantDepartmentDto" } } }, "required": true, "x-bodyName": "plantDepartment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PlantDepartments/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single PlantDepartment record for a given Unique Id.", "description": "This endpoint retrieves a PlantDepartment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPlantDepartments_GetPlantDepartmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single PlantDepartment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPlantDepartments_DeletePlantDepartmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Plants": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing Plants according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPlants_GetAllPlantAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPlantDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single Plant record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPlants_PutPlantAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPlantDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPlantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPlantDto" } } }, "required": true, "x-bodyName": "plant" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Plants/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single Plant record for a given Unique Id.", "description": "This endpoint retrieves a Plant based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPlants_GetPlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single Plant record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPlants_DeletePlantAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPlantDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Priorities": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing Priorities according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPriorities_GetAllPriorityAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPriorityDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPriorityDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPriorityDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPriorityDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single Priority record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPriorities_PutPriorityAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPriorityDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPriorityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPriorityDto" } } }, "required": true, "x-bodyName": "priority" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Priorities/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single Priority record for a given Unique Id.", "description": "This endpoint retrieves a Priority based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPriorities_GetPriorityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single Priority record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPriorities_DeletePriorityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPriorityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Processes": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing Processes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProcesses_GetAllProcessAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProcessDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProcessDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProcessDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProcessDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single Process record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProcesses_PutProcessAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProcessDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProcessDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProcessDto" } } }, "required": true, "x-bodyName": "process" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Processes/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single Process record for a given Unique Id.", "description": "This endpoint retrieves a Process based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProcesses_GetProcessAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single Process record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProcesses_DeleteProcessAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProcessDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionCalendarDays": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ProductionCalendarDays according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductionCalendarDays_GetAllProductionCalendarDayAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDayDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDayDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDayDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDayDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionCalendarDays/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ProductionCalendarDay record for a given Unique Id.", "description": "This endpoint retrieves a ProductionCalendarDay based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductionCalendarDays_GetProductionCalendarDayAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDayDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDayDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDayDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDayDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionCalendars": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ProductionCalendars according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductionCalendars_GetAllProductionCalendarAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionCalendars/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ProductionCalendar record for a given Unique Id.", "description": "This endpoint retrieves a ProductionCalendar based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductionCalendars_GetProductionCalendarAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionCalendarWorkCenters": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ProductionCalendarWorkCenters according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductionCalendarWorkCenters_GetAllProductionCalendarWorkCenterAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarWorkCenterDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarWorkCenterDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarWorkCenterDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionCalendarWorkCenterDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionCalendarWorkCenters/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ProductionCalendarWorkCenter record for a given Unique Id.", "description": "This endpoint retrieves a ProductionCalendarWorkCenter based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductionCalendarWorkCenters_GetProductionCalendarWorkCenterAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarWorkCenterDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarWorkCenterDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarWorkCenterDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionCalendarWorkCenterDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionDepartments": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ProductionDepartments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProductionDepartments_GetAllProductionDepartmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionDepartmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionDepartmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionDepartmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProductionDepartmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single ProductionDepartment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProductionDepartments_PutProductionDepartmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProductionDepartmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProductionDepartmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProductionDepartmentDto" } } }, "required": true, "x-bodyName": "productionDepartment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProductionDepartments/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ProductionDepartment record for a given Unique Id.", "description": "This endpoint retrieves a ProductionDepartment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProductionDepartments_GetProductionDepartmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single ProductionDepartment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProductionDepartments_DeleteProductionDepartmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProductionDepartmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ToolCategories": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ToolCategories according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPToolCategories_GetAllToolCategoryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolCategoryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolCategoryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolCategoryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolCategoryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ToolCategories/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ToolCategory record for a given Unique Id.", "description": "This endpoint retrieves a ToolCategory based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPToolCategories_GetToolCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ToolMemos": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ToolMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPToolMemos_GetAllToolMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single ToolMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPToolMemos_PutToolMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPToolMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPToolMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPToolMemoDto" } } }, "required": true, "x-bodyName": "toolMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ToolMemos/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ToolMemo record for a given Unique Id.", "description": "This endpoint retrieves a ToolMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPToolMemos_GetToolMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single ToolMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPToolMemos_DeleteToolMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ToolMovements": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing ToolMovements according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPToolMovements_GetAllToolMovementAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMovementDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMovementDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMovementDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolMovementDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single ToolMovement record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPToolMovements_PutToolMovementAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPToolMovementDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPToolMovementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPToolMovementDto" } } }, "required": true, "x-bodyName": "toolMovement" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ToolMovements/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single ToolMovement record for a given Unique Id.", "description": "This endpoint retrieves a ToolMovement based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPToolMovements_GetToolMovementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single ToolMovement record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPToolMovements_DeleteToolMovementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolMovementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Tools": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing Tools according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPTools_GetAllToolAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPToolDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single Tool record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTools_PutToolAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPToolDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPToolDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPToolDto" } } }, "required": true, "x-bodyName": "tool" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Tools/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single Tool record for a given Unique Id.", "description": "This endpoint retrieves a Tool based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPTools_GetToolAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single Tool record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPTools_DeleteToolAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPToolDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterMachines": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing WorkCenterMachines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWorkCenterMachines_GetAllWorkCenterMachineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMachineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMachineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMachineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMachineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single WorkCenterMachine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWorkCenterMachines_PutWorkCenterMachineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWorkCenterMachineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWorkCenterMachineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWorkCenterMachineDto" } } }, "required": true, "x-bodyName": "workCenterMachine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterMachines/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single WorkCenterMachine record for a given Unique Id.", "description": "This endpoint retrieves a WorkCenterMachine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWorkCenterMachines_GetWorkCenterMachineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single WorkCenterMachine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWorkCenterMachines_DeleteWorkCenterMachineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMachineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterMemos": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing WorkCenterMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWorkCenterMemos_GetAllWorkCenterMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single WorkCenterMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWorkCenterMemos_PutWorkCenterMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWorkCenterMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWorkCenterMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWorkCenterMemoDto" } } }, "required": true, "x-bodyName": "workCenterMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenterMemos/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single WorkCenterMemo record for a given Unique Id.", "description": "This endpoint retrieves a WorkCenterMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWorkCenterMemos_GetWorkCenterMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single WorkCenterMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWorkCenterMemos_DeleteWorkCenterMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenters": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns all existing WorkCenters according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPWorkCenters_GetAllWorkCenterAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPWorkCenterDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PRODUCTION" ], "summary": "Creates or updates a single WorkCenter record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWorkCenters_PutWorkCenterAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPWorkCenterDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPWorkCenterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPWorkCenterDto" } } }, "required": true, "x-bodyName": "workCenter" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/WorkCenters/{key}": { "get": { "tags": [ "ERP/PRODUCTION" ], "summary": "Returns a single WorkCenter record for a given Unique Id.", "description": "This endpoint retrieves a WorkCenter based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPWorkCenters_GetWorkCenterAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PRODUCTION" ], "summary": "Deletes a single WorkCenter record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPWorkCenters_DeleteWorkCenterAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPWorkCenterDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectAreas": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns all existing ProjectAreas according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProjectAreas_GetAllProjectAreaAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectAreaDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectAreaDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectAreaDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectAreaDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PROJECTS" ], "summary": "Creates or updates a single ProjectArea record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectAreas_PutProjectAreaAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProjectAreaDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProjectAreaDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProjectAreaDto" } } }, "required": true, "x-bodyName": "projectArea" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectAreas/{key}": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns a single ProjectArea record for a given Unique Id.", "description": "This endpoint retrieves a ProjectArea based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProjectAreas_GetProjectAreaAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PROJECTS" ], "summary": "Deletes a single ProjectArea record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectAreas_DeleteProjectAreaAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectAreaDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectContacts": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns all existing ProjectContacts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProjectContacts_GetAllProjectContactAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectContactDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectContactDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectContactDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectContactDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PROJECTS" ], "summary": "Creates or updates a single ProjectContact record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectContacts_PutProjectContactAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProjectContactDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProjectContactDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProjectContactDto" } } }, "required": true, "x-bodyName": "projectContact" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectContacts/{key}": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns a single ProjectContact record for a given Unique Id.", "description": "This endpoint retrieves a ProjectContact based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProjectContacts_GetProjectContactAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PROJECTS" ], "summary": "Deletes a single ProjectContact record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectContacts_DeleteProjectContactAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectContactDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Projects": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns all existing Projects according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProjects_GetAllProjectAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PROJECTS" ], "summary": "Creates or updates a single Project record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjects_PutProjectAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProjectDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProjectDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProjectDto" } } }, "required": true, "x-bodyName": "project" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Projects/{key}": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns a single Project record for a given Unique Id.", "description": "This endpoint retrieves a Project based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProjects_GetProjectAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PROJECTS" ], "summary": "Deletes a single Project record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjects_DeleteProjectAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectTypes": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns all existing ProjectTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPProjectTypes_GetAllProjectTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPProjectTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PROJECTS" ], "summary": "Creates or updates a single ProjectType record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectTypes_PutProjectTypeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPProjectTypeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPProjectTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPProjectTypeDto" } } }, "required": true, "x-bodyName": "projectType" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ProjectTypes/{key}": { "get": { "tags": [ "ERP/PROJECTS" ], "summary": "Returns a single ProjectType record for a given Unique Id.", "description": "This endpoint retrieves a ProjectType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPProjectTypes_GetProjectTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PROJECTS" ], "summary": "Deletes a single ProjectType record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPProjectTypes_DeleteProjectTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPProjectTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderAccounts": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrderAccounts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrderAccounts_GetAllPurchaseOrderAccountAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderAccountDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderAccountDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderAccountDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderAccountDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrderAccount record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderAccounts_PutPurchaseOrderAccountAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderAccountDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderAccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderAccountDto" } } }, "required": true, "x-bodyName": "purchaseOrderAccount" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderAccounts/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrderAccount record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrderAccount based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrderAccounts_GetPurchaseOrderAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrderAccount record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderAccounts_DeletePurchaseOrderAccountAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderAccountDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderApprovals": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrderApprovals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrderApprovals_GetAllPurchaseOrderApprovalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderApprovalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderApprovalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderApprovalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderApprovalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrderApproval record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderApprovals_PutPurchaseOrderApprovalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderApprovalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderApprovalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderApprovalDto" } } }, "required": true, "x-bodyName": "purchaseOrderApproval" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderApprovals/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrderApproval record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrderApproval based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrderApprovals_GetPurchaseOrderApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrderApproval record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderApprovals_DeletePurchaseOrderApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderComponents": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrderComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrderComponents_GetAllPurchaseOrderComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrderComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderComponents_PutPurchaseOrderComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderComponentDto" } } }, "required": true, "x-bodyName": "purchaseOrderComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderComponents/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrderComponent record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrderComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrderComponents_GetPurchaseOrderComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrderComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderComponents_DeletePurchaseOrderComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderDeliveries": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrderDeliveries according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrderDeliveries_GetAllPurchaseOrderDeliveryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDeliveryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDeliveryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDeliveryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDeliveryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrderDelivery record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderDeliveries_PutPurchaseOrderDeliveryAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderDeliveryDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderDeliveryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderDeliveryDto" } } }, "required": true, "x-bodyName": "purchaseOrderDelivery" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderDeliveries/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrderDelivery record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrderDelivery based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrderDeliveries_GetPurchaseOrderDeliveryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrderDelivery record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderDeliveries_DeletePurchaseOrderDeliveryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderLines": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrderLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrderLines_GetAllPurchaseOrderLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrderLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderLines_PutPurchaseOrderLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderLineDto" } } }, "required": true, "x-bodyName": "purchaseOrderLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderLines/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrderLine record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrderLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrderLines_GetPurchaseOrderLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrderLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderLines_DeletePurchaseOrderLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderMemos": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrderMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrderMemos_GetAllPurchaseOrderMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrderMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderMemos_PutPurchaseOrderMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderMemoDto" } } }, "required": true, "x-bodyName": "purchaseOrderMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrderMemos/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrderMemo record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrderMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrderMemos_GetPurchaseOrderMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrderMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrderMemos_DeletePurchaseOrderMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrders": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchaseOrders according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchaseOrders_GetAllPurchaseOrderAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchaseOrderDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchaseOrder record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrders_PutPurchaseOrderAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchaseOrderDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchaseOrderDto" } } }, "required": true, "x-bodyName": "purchaseOrder" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchaseOrders/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchaseOrder record for a given Unique Id.", "description": "This endpoint retrieves a PurchaseOrder based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchaseOrders_GetPurchaseOrderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchaseOrder record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchaseOrders_DeletePurchaseOrderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchaseOrderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerLines": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchasePlannerLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchasePlannerLines_GetAllPurchasePlannerLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchasePlannerLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerLines_PutPurchasePlannerLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchasePlannerLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerLineDto" } } }, "required": true, "x-bodyName": "purchasePlannerLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerLines/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchasePlannerLine record for a given Unique Id.", "description": "This endpoint retrieves a PurchasePlannerLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchasePlannerLines_GetPurchasePlannerLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchasePlannerLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerLines_DeletePurchasePlannerLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerOrderDetails": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchasePlannerOrderDetails according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchasePlannerOrderDetails_GetAllPurchasePlannerOrderDetailAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerOrderDetailDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerOrderDetailDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerOrderDetailDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerOrderDetailDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchasePlannerOrderDetail record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerOrderDetails_PutPurchasePlannerOrderDetailAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchasePlannerOrderDetailDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerOrderDetailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerOrderDetailDto" } } }, "required": true, "x-bodyName": "purchasePlannerOrderDetail" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerOrderDetails/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchasePlannerOrderDetail record for a given Unique Id.", "description": "This endpoint retrieves a PurchasePlannerOrderDetail based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchasePlannerOrderDetails_GetPurchasePlannerOrderDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchasePlannerOrderDetail record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerOrderDetails_DeletePurchasePlannerOrderDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerRequirements": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchasePlannerRequirements according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchasePlannerRequirements_GetAllPurchasePlannerRequirementAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerRequirementDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerRequirementDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerRequirementDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerRequirementDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchasePlannerRequirement record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerRequirements_PutPurchasePlannerRequirementAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchasePlannerRequirementDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerRequirementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerRequirementDto" } } }, "required": true, "x-bodyName": "purchasePlannerRequirement" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerRequirements/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchasePlannerRequirement record for a given Unique Id.", "description": "This endpoint retrieves a PurchasePlannerRequirement based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchasePlannerRequirements_GetPurchasePlannerRequirementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchasePlannerRequirement record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerRequirements_DeletePurchasePlannerRequirementAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerSessions": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing PurchasePlannerSessions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPPurchasePlannerSessions_GetAllPurchasePlannerSessionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerSessionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerSessionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerSessionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPPurchasePlannerSessionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single PurchasePlannerSession record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerSessions_PutPurchasePlannerSessionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPPurchasePlannerSessionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerSessionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPPurchasePlannerSessionDto" } } }, "required": true, "x-bodyName": "purchasePlannerSession" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/PurchasePlannerSessions/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single PurchasePlannerSession record for a given Unique Id.", "description": "This endpoint retrieves a PurchasePlannerSession based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPPurchasePlannerSessions_GetPurchasePlannerSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single PurchasePlannerSession record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPPurchasePlannerSessions_DeletePurchasePlannerSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPPurchasePlannerSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQLines": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing RFQLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRFQLines_GetAllRFQLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single RFQLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQLines_PutRFQLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRFQLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRFQLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRFQLineDto" } } }, "required": true, "x-bodyName": "rFQLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQLines/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single RFQLine record for a given Unique Id.", "description": "This endpoint retrieves a RFQLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRFQLines_GetRFQLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single RFQLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQLines_DeleteRFQLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQMemos": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing RFQMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRFQMemos_GetAllRFQMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single RFQMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQMemos_PutRFQMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRFQMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRFQMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRFQMemoDto" } } }, "required": true, "x-bodyName": "rFQMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQMemos/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single RFQMemo record for a given Unique Id.", "description": "This endpoint retrieves a RFQMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRFQMemos_GetRFQMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single RFQMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQMemos_DeleteRFQMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQQuantities": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing RFQQuantities according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRFQQuantities_GetAllRFQQuantityAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQQuantityDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQQuantityDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQQuantityDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQQuantityDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single RFQQuantity record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQQuantities_PutRFQQuantityAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRFQQuantityDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRFQQuantityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRFQQuantityDto" } } }, "required": true, "x-bodyName": "rFQQuantity" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQQuantities/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single RFQQuantity record for a given Unique Id.", "description": "This endpoint retrieves a RFQQuantity based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRFQQuantities_GetRFQQuantityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single RFQQuantity record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQQuantities_DeleteRFQQuantityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQQuantityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQs": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing RFQs according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRFQs_GetAllRFQAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single RFQ record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQs_PutRFQAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRFQDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRFQDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRFQDto" } } }, "required": true, "x-bodyName": "rFQ" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQs/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single RFQ record for a given Unique Id.", "description": "This endpoint retrieves a RFQ based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRFQs_GetRFQAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single RFQ record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQs_DeleteRFQAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQSuppliers": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns all existing RFQSuppliers according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRFQSuppliers_GetAllRFQSupplierAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQSupplierDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQSupplierDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQSupplierDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRFQSupplierDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Creates or updates a single RFQSupplier record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQSuppliers_PutRFQSupplierAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRFQSupplierDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRFQSupplierDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRFQSupplierDto" } } }, "required": true, "x-bodyName": "rFQSupplier" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RFQSuppliers/{key}": { "get": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Returns a single RFQSupplier record for a given Unique Id.", "description": "This endpoint retrieves a RFQSupplier based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRFQSuppliers_GetRFQSupplierAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASEORDERS" ], "summary": "Deletes a single RFQSupplier record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRFQSuppliers_DeleteRFQSupplierAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRFQSupplierDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ReceiptComponents": { "get": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Returns all existing ReceiptComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPReceiptComponents_GetAllReceiptComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Creates or updates a single ReceiptComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPReceiptComponents_PutReceiptComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPReceiptComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPReceiptComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPReceiptComponentDto" } } }, "required": true, "x-bodyName": "receiptComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ReceiptComponents/{key}": { "get": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Returns a single ReceiptComponent record for a given Unique Id.", "description": "This endpoint retrieves a ReceiptComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPReceiptComponents_GetReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Deletes a single ReceiptComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPReceiptComponents_DeleteReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ReceiptLines": { "get": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Returns all existing ReceiptLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPReceiptLines_GetAllReceiptLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Creates or updates a single ReceiptLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPReceiptLines_PutReceiptLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPReceiptLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPReceiptLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPReceiptLineDto" } } }, "required": true, "x-bodyName": "receiptLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ReceiptLines/{key}": { "get": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Returns a single ReceiptLine record for a given Unique Id.", "description": "This endpoint retrieves a ReceiptLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPReceiptLines_GetReceiptLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Deletes a single ReceiptLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPReceiptLines_DeleteReceiptLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Receipts": { "get": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Returns all existing Receipts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPReceipts_GetAllReceiptAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPReceiptDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Creates or updates a single Receipt record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPReceipts_PutReceiptAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPReceiptDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPReceiptDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPReceiptDto" } } }, "required": true, "x-bodyName": "receipt" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Receipts/{key}": { "get": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Returns a single Receipt record for a given Unique Id.", "description": "This endpoint retrieves a Receipt based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPReceipts_GetReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/PURCHASERECEIPTS" ], "summary": "Deletes a single Receipt record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPReceipts_DeleteReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CorrectiveActionCategories": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing CorrectiveActionCategories according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCorrectiveActionCategories_GetAllCorrectiveActionCategoryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCategoryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCategoryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCategoryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCategoryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single CorrectiveActionCategory record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCorrectiveActionCategories_PutCorrectiveActionCategoryAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCorrectiveActionCategoryDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCorrectiveActionCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCorrectiveActionCategoryDto" } } }, "required": true, "x-bodyName": "correctiveActionCategory" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CorrectiveActionCategories/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single CorrectiveActionCategory record for a given Unique Id.", "description": "This endpoint retrieves a CorrectiveActionCategory based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCorrectiveActionCategories_GetCorrectiveActionCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single CorrectiveActionCategory record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCorrectiveActionCategories_DeleteCorrectiveActionCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CorrectiveActionCodes": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing CorrectiveActionCodes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCorrectiveActionCodes_GetAllCorrectiveActionCodeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCodeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCodeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCodeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCorrectiveActionCodeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single CorrectiveActionCode record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCorrectiveActionCodes_PutCorrectiveActionCodeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCorrectiveActionCodeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCorrectiveActionCodeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCorrectiveActionCodeDto" } } }, "required": true, "x-bodyName": "correctiveActionCode" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CorrectiveActionCodes/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single CorrectiveActionCode record for a given Unique Id.", "description": "This endpoint retrieves a CorrectiveActionCode based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCorrectiveActionCodes_GetCorrectiveActionCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single CorrectiveActionCode record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCorrectiveActionCodes_DeleteCorrectiveActionCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCorrectiveActionCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRClaimComponents": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing DMRClaimComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDMRClaimComponents_GetAllDMRClaimComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single DMRClaimComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRClaimComponents_PutDMRClaimComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDMRClaimComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDMRClaimComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDMRClaimComponentDto" } } }, "required": true, "x-bodyName": "dMRClaimComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRClaimComponents/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single DMRClaimComponent record for a given Unique Id.", "description": "This endpoint retrieves a DMRClaimComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDMRClaimComponents_GetDMRClaimComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single DMRClaimComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRClaimComponents_DeleteDMRClaimComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRClaimLines": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing DMRClaimLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDMRClaimLines_GetAllDMRClaimLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single DMRClaimLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRClaimLines_PutDMRClaimLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDMRClaimLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDMRClaimLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDMRClaimLineDto" } } }, "required": true, "x-bodyName": "dMRClaimLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRClaimLines/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single DMRClaimLine record for a given Unique Id.", "description": "This endpoint retrieves a DMRClaimLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDMRClaimLines_GetDMRClaimLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single DMRClaimLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRClaimLines_DeleteDMRClaimLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRClaims": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing DMRClaims according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDMRClaims_GetAllDMRClaimAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRClaimDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single DMRClaim record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRClaims_PutDMRClaimAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDMRClaimDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDMRClaimDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDMRClaimDto" } } }, "required": true, "x-bodyName": "dMRClaim" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRClaims/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single DMRClaim record for a given Unique Id.", "description": "This endpoint retrieves a DMRClaim based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDMRClaims_GetDMRClaimAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single DMRClaim record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRClaims_DeleteDMRClaimAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRClaimDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRShipmentComponents": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing DMRShipmentComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDMRShipmentComponents_GetAllDMRShipmentComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single DMRShipmentComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRShipmentComponents_PutDMRShipmentComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDMRShipmentComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDMRShipmentComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDMRShipmentComponentDto" } } }, "required": true, "x-bodyName": "dMRShipmentComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRShipmentComponents/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single DMRShipmentComponent record for a given Unique Id.", "description": "This endpoint retrieves a DMRShipmentComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDMRShipmentComponents_GetDMRShipmentComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single DMRShipmentComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRShipmentComponents_DeleteDMRShipmentComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRShipmentLines": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing DMRShipmentLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDMRShipmentLines_GetAllDMRShipmentLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single DMRShipmentLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRShipmentLines_PutDMRShipmentLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDMRShipmentLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDMRShipmentLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDMRShipmentLineDto" } } }, "required": true, "x-bodyName": "dMRShipmentLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRShipmentLines/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single DMRShipmentLine record for a given Unique Id.", "description": "This endpoint retrieves a DMRShipmentLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDMRShipmentLines_GetDMRShipmentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single DMRShipmentLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRShipmentLines_DeleteDMRShipmentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRShipments": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing DMRShipments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDMRShipments_GetAllDMRShipmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDMRShipmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single DMRShipment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRShipments_PutDMRShipmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPDMRShipmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPDMRShipmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPDMRShipmentDto" } } }, "required": true, "x-bodyName": "dMRShipment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DMRShipments/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single DMRShipment record for a given Unique Id.", "description": "This endpoint retrieves a DMRShipment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDMRShipments_GetDMRShipmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single DMRShipment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPDMRShipments_DeleteDMRShipmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDMRShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InspectionComponents": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing InspectionComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPInspectionComponents_GetAllInspectionComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single InspectionComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspectionComponents_PutInspectionComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPInspectionComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionComponentDto" } } }, "required": true, "x-bodyName": "inspectionComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InspectionComponents/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single InspectionComponent record for a given Unique Id.", "description": "This endpoint retrieves a InspectionComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPInspectionComponents_GetInspectionComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single InspectionComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspectionComponents_DeleteInspectionComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InspectionLineApprovals": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing InspectionLineApprovals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPInspectionLineApprovals_GetAllInspectionLineApprovalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineApprovalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineApprovalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineApprovalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineApprovalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single InspectionLineApproval record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspectionLineApprovals_PutInspectionLineApprovalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPInspectionLineApprovalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionLineApprovalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionLineApprovalDto" } } }, "required": true, "x-bodyName": "inspectionLineApproval" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InspectionLineApprovals/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single InspectionLineApproval record for a given Unique Id.", "description": "This endpoint retrieves a InspectionLineApproval based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPInspectionLineApprovals_GetInspectionLineApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single InspectionLineApproval record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspectionLineApprovals_DeleteInspectionLineApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InspectionLines": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing InspectionLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPInspectionLines_GetAllInspectionLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single InspectionLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspectionLines_PutInspectionLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPInspectionLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionLineDto" } } }, "required": true, "x-bodyName": "inspectionLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/InspectionLines/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single InspectionLine record for a given Unique Id.", "description": "This endpoint retrieves a InspectionLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPInspectionLines_GetInspectionLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single InspectionLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspectionLines_DeleteInspectionLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Inspections": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing Inspections according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPInspections_GetAllInspectionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPInspectionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single Inspection record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspections_PutInspectionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPInspectionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPInspectionDto" } } }, "required": true, "x-bodyName": "inspection" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Inspections/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single Inspection record for a given Unique Id.", "description": "This endpoint retrieves a Inspection based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPInspections_GetInspectionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single Inspection record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPInspections_DeleteInspectionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPInspectionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformanceCategories": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing NonConformanceCategories according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPNonConformanceCategories_GetAllNonConformanceCategoryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCategoryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCategoryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCategoryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCategoryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single NonConformanceCategory record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformanceCategories_PutNonConformanceCategoryAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPNonConformanceCategoryDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceCategoryDto" } } }, "required": true, "x-bodyName": "nonConformanceCategory" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformanceCategories/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single NonConformanceCategory record for a given Unique Id.", "description": "This endpoint retrieves a NonConformanceCategory based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPNonConformanceCategories_GetNonConformanceCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single NonConformanceCategory record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformanceCategories_DeleteNonConformanceCategoryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCategoryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformanceCauses": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing NonConformanceCauses according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPNonConformanceCauses_GetAllNonConformanceCauseAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCauseDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCauseDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCauseDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCauseDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single NonConformanceCause record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformanceCauses_PutNonConformanceCauseAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPNonConformanceCauseDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceCauseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceCauseDto" } } }, "required": true, "x-bodyName": "nonConformanceCause" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformanceCauses/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single NonConformanceCause record for a given Unique Id.", "description": "This endpoint retrieves a NonConformanceCause based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPNonConformanceCauses_GetNonConformanceCauseAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single NonConformanceCause record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformanceCauses_DeleteNonConformanceCauseAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCauseDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformanceCodes": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing NonConformanceCodes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPNonConformanceCodes_GetAllNonConformanceCodeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCodeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCodeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCodeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceCodeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single NonConformanceCode record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformanceCodes_PutNonConformanceCodeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPNonConformanceCodeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceCodeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceCodeDto" } } }, "required": true, "x-bodyName": "nonConformanceCode" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformanceCodes/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single NonConformanceCode record for a given Unique Id.", "description": "This endpoint retrieves a NonConformanceCode based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPNonConformanceCodes_GetNonConformanceCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single NonConformanceCode record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformanceCodes_DeleteNonConformanceCodeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceCodeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformances": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing NonConformances according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPNonConformances_GetAllNonConformanceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPNonConformanceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single NonConformance record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformances_PutNonConformanceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPNonConformanceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPNonConformanceDto" } } }, "required": true, "x-bodyName": "nonConformance" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/NonConformances/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single NonConformance record for a given Unique Id.", "description": "This endpoint retrieves a NonConformance based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPNonConformances_GetNonConformanceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single NonConformance record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPNonConformances_DeleteNonConformanceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPNonConformanceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAActionTypes": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAActionTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAActionTypes_GetAllRMAActionTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAActionTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAActionTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAActionTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAActionTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAActionTypes/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAActionType record for a given Unique Id.", "description": "This endpoint retrieves a RMAActionType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAActionTypes_GetRMAActionTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAActionTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAActionTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAActionTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAActionTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAClaimComponents": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAClaimComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAClaimComponents_GetAllRMAClaimComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single RMAClaimComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAClaimComponents_PutRMAClaimComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRMAClaimComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRMAClaimComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRMAClaimComponentDto" } } }, "required": true, "x-bodyName": "rMAClaimComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAClaimComponents/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAClaimComponent record for a given Unique Id.", "description": "This endpoint retrieves a RMAClaimComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAClaimComponents_GetRMAClaimComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single RMAClaimComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAClaimComponents_DeleteRMAClaimComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAClaimLines": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAClaimLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAClaimLines_GetAllRMAClaimLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single RMAClaimLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAClaimLines_PutRMAClaimLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRMAClaimLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRMAClaimLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRMAClaimLineDto" } } }, "required": true, "x-bodyName": "rMAClaimLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAClaimLines/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAClaimLine record for a given Unique Id.", "description": "This endpoint retrieves a RMAClaimLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAClaimLines_GetRMAClaimLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single RMAClaimLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAClaimLines_DeleteRMAClaimLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAClaims": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAClaims according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAClaims_GetAllRMAClaimAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAClaimDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single RMAClaim record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAClaims_PutRMAClaimAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRMAClaimDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRMAClaimDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRMAClaimDto" } } }, "required": true, "x-bodyName": "rMAClaim" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAClaims/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAClaim record for a given Unique Id.", "description": "This endpoint retrieves a RMAClaim based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAClaims_GetRMAClaimAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single RMAClaim record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAClaims_DeleteRMAClaimAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAClaimDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAReceiptComponents": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAReceiptComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAReceiptComponents_GetAllRMAReceiptComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single RMAReceiptComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAReceiptComponents_PutRMAReceiptComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRMAReceiptComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRMAReceiptComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRMAReceiptComponentDto" } } }, "required": true, "x-bodyName": "rMAReceiptComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAReceiptComponents/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAReceiptComponent record for a given Unique Id.", "description": "This endpoint retrieves a RMAReceiptComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAReceiptComponents_GetRMAReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single RMAReceiptComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAReceiptComponents_DeleteRMAReceiptComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAReceiptLines": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAReceiptLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAReceiptLines_GetAllRMAReceiptLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single RMAReceiptLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAReceiptLines_PutRMAReceiptLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRMAReceiptLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRMAReceiptLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRMAReceiptLineDto" } } }, "required": true, "x-bodyName": "rMAReceiptLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAReceiptLines/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAReceiptLine record for a given Unique Id.", "description": "This endpoint retrieves a RMAReceiptLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAReceiptLines_GetRMAReceiptLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single RMAReceiptLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAReceiptLines_DeleteRMAReceiptLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAReceipts": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns all existing RMAReceipts according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPRMAReceipts_GetAllRMAReceiptAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPRMAReceiptDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUALITY" ], "summary": "Creates or updates a single RMAReceipt record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAReceipts_PutRMAReceiptAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPRMAReceiptDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPRMAReceiptDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPRMAReceiptDto" } } }, "required": true, "x-bodyName": "rMAReceipt" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/RMAReceipts/{key}": { "get": { "tags": [ "ERP/QUALITY" ], "summary": "Returns a single RMAReceipt record for a given Unique Id.", "description": "This endpoint retrieves a RMAReceipt based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPRMAReceipts_GetRMAReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUALITY" ], "summary": "Deletes a single RMAReceipt record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPRMAReceipts_DeleteRMAReceiptAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPRMAReceiptDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteAssemblies": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteAssemblies according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteAssemblies_GetAllQuoteAssemblyAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteAssemblyDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteAssemblyDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteAssemblyDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteAssemblyDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteAssembly record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteAssemblies_PutQuoteAssemblyAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteAssemblyDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteAssemblyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteAssemblyDto" } } }, "required": true, "x-bodyName": "quoteAssembly" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteAssemblies/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteAssembly record for a given Unique Id.", "description": "This endpoint retrieves a QuoteAssembly based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteAssemblies_GetQuoteAssemblyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteAssembly record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteAssemblies_DeleteQuoteAssemblyAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteAssemblyDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteLines": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteLines_GetAllQuoteLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteLines_PutQuoteLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteLineDto" } } }, "required": true, "x-bodyName": "quoteLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteLines/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteLine record for a given Unique Id.", "description": "This endpoint retrieves a QuoteLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteLines_GetQuoteLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteLines_DeleteQuoteLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteMaterials": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteMaterials according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteMaterials_GetAllQuoteMaterialAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMaterialDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMaterialDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMaterialDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMaterialDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteMaterial record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteMaterials_PutQuoteMaterialAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteMaterialDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteMaterialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteMaterialDto" } } }, "required": true, "x-bodyName": "quoteMaterial" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteMaterials/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteMaterial record for a given Unique Id.", "description": "This endpoint retrieves a QuoteMaterial based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteMaterials_GetQuoteMaterialAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteMaterial record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteMaterials_DeleteQuoteMaterialAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMaterialDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteMemos": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteMemos_GetAllQuoteMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteMemos_PutQuoteMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteMemoDto" } } }, "required": true, "x-bodyName": "quoteMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteMemos/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteMemo record for a given Unique Id.", "description": "This endpoint retrieves a QuoteMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteMemos_GetQuoteMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteMemos_DeleteQuoteMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteOperations": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteOperations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteOperations_GetAllQuoteOperationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteOperationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteOperationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteOperationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteOperationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteOperation record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteOperations_PutQuoteOperationAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteOperationDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteOperationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteOperationDto" } } }, "required": true, "x-bodyName": "quoteOperation" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteOperations/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteOperation record for a given Unique Id.", "description": "This endpoint retrieves a QuoteOperation based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteOperations_GetQuoteOperationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteOperation record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteOperations_DeleteQuoteOperationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteOperationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteQuantities": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteQuantities according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteQuantities_GetAllQuoteQuantityAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteQuantityDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteQuantityDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteQuantityDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteQuantityDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteQuantity record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteQuantities_PutQuoteQuantityAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteQuantityDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteQuantityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteQuantityDto" } } }, "required": true, "x-bodyName": "quoteQuantity" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteQuantities/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteQuantity record for a given Unique Id.", "description": "This endpoint retrieves a QuoteQuantity based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteQuantities_GetQuoteQuantityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteQuantity record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteQuantities_DeleteQuoteQuantityAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteQuantityDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Quotes": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing Quotes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuotes_GetAllQuoteAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single Quote record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuotes_PutQuoteAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteDto" } } }, "required": true, "x-bodyName": "quote" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Quotes/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single Quote record for a given Unique Id.", "description": "This endpoint retrieves a Quote based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuotes_GetQuoteAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single Quote record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuotes_DeleteQuoteAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteSalesPeople": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns all existing QuoteSalesPeople according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPQuoteSalesPeople_GetAllQuoteSalesPersonAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteSalesPersonDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteSalesPersonDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteSalesPersonDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPQuoteSalesPersonDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Creates or updates a single QuoteSalesPerson record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteSalesPeople_PutQuoteSalesPersonAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPQuoteSalesPersonDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteSalesPersonDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPQuoteSalesPersonDto" } } }, "required": true, "x-bodyName": "quoteSalesPerson" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/QuoteSalesPeople/{key}": { "get": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Returns a single QuoteSalesPerson record for a given Unique Id.", "description": "This endpoint retrieves a QuoteSalesPerson based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPQuoteSalesPeople_GetQuoteSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/QUOTATIONS" ], "summary": "Deletes a single QuoteSalesPerson record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPQuoteSalesPeople_DeleteQuoteSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPQuoteSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderApprovals": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderApprovals according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderApprovals_GetAllSalesOrderApprovalAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderApprovalDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderApprovalDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderApprovalDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderApprovalDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderApproval record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderApprovals_PutSalesOrderApprovalAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderApprovalDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderApprovalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderApprovalDto" } } }, "required": true, "x-bodyName": "salesOrderApproval" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderApprovals/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderApproval record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderApproval based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderApprovals_GetSalesOrderApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderApproval record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderApprovals_DeleteSalesOrderApprovalAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderApprovalDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderComponents": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderComponents_GetAllSalesOrderComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderComponents_PutSalesOrderComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderComponentDto" } } }, "required": true, "x-bodyName": "salesOrderComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderComponents/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderComponent record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderComponents_GetSalesOrderComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderComponents_DeleteSalesOrderComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderDeliveries": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderDeliveries according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderDeliveries_GetAllSalesOrderDeliveryAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDeliveryDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDeliveryDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDeliveryDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDeliveryDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderDelivery record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderDeliveries_PutSalesOrderDeliveryAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderDeliveryDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderDeliveryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderDeliveryDto" } } }, "required": true, "x-bodyName": "salesOrderDelivery" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderDeliveries/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderDelivery record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderDelivery based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderDeliveries_GetSalesOrderDeliveryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderDelivery record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderDeliveries_DeleteSalesOrderDeliveryAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDeliveryDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderJobLinks": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderJobLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderJobLinks_GetAllSalesOrderJobLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderJobLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderJobLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderJobLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderJobLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderJobLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderJobLinks_PutSalesOrderJobLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderJobLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderJobLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderJobLinkDto" } } }, "required": true, "x-bodyName": "salesOrderJobLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderJobLinks/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderJobLink record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderJobLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderJobLinks_GetSalesOrderJobLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderJobLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderJobLinks_DeleteSalesOrderJobLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderJobLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderLines": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderLines_GetAllSalesOrderLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderLines_PutSalesOrderLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderLineDto" } } }, "required": true, "x-bodyName": "salesOrderLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderLines/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderLine record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderLines_GetSalesOrderLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderLines_DeleteSalesOrderLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderMemos": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderMemos according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderMemos_GetAllSalesOrderMemoAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderMemoDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderMemoDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderMemoDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderMemoDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderMemo record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderMemos_PutSalesOrderMemoAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderMemoDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderMemoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderMemoDto" } } }, "required": true, "x-bodyName": "salesOrderMemo" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderMemos/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderMemo record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderMemo based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderMemos_GetSalesOrderMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderMemo record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderMemos_DeleteSalesOrderMemoAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderMemoDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderPickListLines": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderPickListLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderPickListLines_GetAllSalesOrderPickListLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderPickListLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderPickListLines_PutSalesOrderPickListLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderPickListLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderPickListLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderPickListLineDto" } } }, "required": true, "x-bodyName": "salesOrderPickListLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderPickListLines/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderPickListLine record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderPickListLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderPickListLines_GetSalesOrderPickListLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderPickListLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderPickListLines_DeleteSalesOrderPickListLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderPickListSessions": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderPickListSessions according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderPickListSessions_GetAllSalesOrderPickListSessionAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListSessionDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListSessionDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListSessionDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderPickListSessionDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderPickListSession record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderPickListSessions_PutSalesOrderPickListSessionAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderPickListSessionDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderPickListSessionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderPickListSessionDto" } } }, "required": true, "x-bodyName": "salesOrderPickListSession" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderPickListSessions/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderPickListSession record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderPickListSession based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderPickListSessions_GetSalesOrderPickListSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderPickListSession record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderPickListSessions_DeleteSalesOrderPickListSessionAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrders": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrders according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrders_GetAllSalesOrderAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrder record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrders_PutSalesOrderAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderDto" } } }, "required": true, "x-bodyName": "salesOrder" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrders/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrder record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrder based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrders_GetSalesOrderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrder record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrders_DeleteSalesOrderAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderSalesPeople": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns all existing SalesOrderSalesPeople according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPSalesOrderSalesPeople_GetAllSalesOrderSalesPersonAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderSalesPersonDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderSalesPersonDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderSalesPersonDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPSalesOrderSalesPersonDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SALESORDERS" ], "summary": "Creates or updates a single SalesOrderSalesPerson record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderSalesPeople_PutSalesOrderSalesPersonAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPSalesOrderSalesPersonDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderSalesPersonDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPSalesOrderSalesPersonDto" } } }, "required": true, "x-bodyName": "salesOrderSalesPerson" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/SalesOrderSalesPeople/{key}": { "get": { "tags": [ "ERP/SALESORDERS" ], "summary": "Returns a single SalesOrderSalesPerson record for a given Unique Id.", "description": "This endpoint retrieves a SalesOrderSalesPerson based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPSalesOrderSalesPeople_GetSalesOrderSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SALESORDERS" ], "summary": "Deletes a single SalesOrderSalesPerson record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPSalesOrderSalesPeople_DeleteSalesOrderSalesPersonAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleAllocations": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns all existing ScheduleAllocations according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPScheduleAllocations_GetAllScheduleAllocationAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleAllocationDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleAllocationDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleAllocationDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleAllocationDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleAllocations/{key}": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns a single ScheduleAllocation record for a given Unique Id.", "description": "This endpoint retrieves a ScheduleAllocation based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPScheduleAllocations_GetScheduleAllocationAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleAllocationDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleAllocationDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleAllocationDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleAllocationDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleBranches": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns all existing ScheduleBranches according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPScheduleBranches_GetAllScheduleBranchAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleBranchDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleBranchDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleBranchDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleBranchDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleBranches/{key}": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns a single ScheduleBranch record for a given Unique Id.", "description": "This endpoint retrieves a ScheduleBranch based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPScheduleBranches_GetScheduleBranchAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleBranchDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleBranchDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleBranchDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleBranchDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleResourceLanes": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns all existing ScheduleResourceLanes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPScheduleResourceLanes_GetAllScheduleResourceLaneAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleResourceLaneDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleResourceLaneDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleResourceLaneDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleResourceLaneDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleResourceLanes/{key}": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns a single ScheduleResourceLane record for a given Unique Id.", "description": "This endpoint retrieves a ScheduleResourceLane based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPScheduleResourceLanes_GetScheduleResourceLaneAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleResourceLaneDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleResourceLaneDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleResourceLaneDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleResourceLaneDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleTaskBuckets": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns all existing ScheduleTaskBuckets according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPScheduleTaskBuckets_GetAllScheduleTaskBucketAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskBucketDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskBucketDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskBucketDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskBucketDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleTaskBuckets/{key}": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns a single ScheduleTaskBucket record for a given Unique Id.", "description": "This endpoint retrieves a ScheduleTaskBucket based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPScheduleTaskBuckets_GetScheduleTaskBucketAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskBucketDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskBucketDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskBucketDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskBucketDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleTasks": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns all existing ScheduleTasks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPScheduleTasks_GetAllScheduleTaskAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTaskDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleTasks/{key}": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns a single ScheduleTask record for a given Unique Id.", "description": "This endpoint retrieves a ScheduleTask based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPScheduleTasks_GetScheduleTaskAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTaskDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleTrees": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns all existing ScheduleTrees according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPScheduleTrees_GetAllScheduleTreeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTreeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTreeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTreeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPScheduleTreeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ScheduleTrees/{key}": { "get": { "tags": [ "ERP/SCHEDULING" ], "summary": "Returns a single ScheduleTree record for a given Unique Id.", "description": "This endpoint retrieves a ScheduleTree based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPScheduleTrees_GetScheduleTreeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTreeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTreeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTreeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPScheduleTreeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DDFields": { "get": { "tags": [ "ERP/SCHEMA" ], "summary": "Returns all existing DDFields according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDDFields_GetAllDDFieldAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDFieldDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDFieldDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDFieldDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDFieldDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DDFields/{key}": { "get": { "tags": [ "ERP/SCHEMA" ], "summary": "Returns a single DDField record for a given Unique Id.", "description": "This endpoint retrieves a DDField based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDDFields_GetDDFieldAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDFieldDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDFieldDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDFieldDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDFieldDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DDTables": { "get": { "tags": [ "ERP/SCHEMA" ], "summary": "Returns all existing DDTables according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPDDTables_GetAllDDTableAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDTableDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDTableDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDTableDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPDDTableDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/DDTables/{key}": { "get": { "tags": [ "ERP/SCHEMA" ], "summary": "Returns a single DDTable record for a given Unique Id.", "description": "This endpoint retrieves a DDTable based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPDDTables_GetDDTableAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDTableDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDTableDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDTableDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPDDTableDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/IntegrationTransactionQueue": { "get": { "tags": [ "ERP/SHARED" ], "summary": "Returns all existing IntegrationTransactionQueue according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "MesIntegrationTransactionQueue_GetAllIntegrationTransactionQueueAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIntegrationTransactionQueueDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIntegrationTransactionQueueDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIntegrationTransactionQueueDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPIntegrationTransactionQueueDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/IntegrationTransactionQueue/{key}": { "get": { "tags": [ "ERP/SHARED" ], "summary": "Returns a single IntegrationTransactionQueue record for a given Unique Id.", "description": "This endpoint retrieves a IntegrationTransactionQueue based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "MesIntegrationTransactionQueue_GetIntegrationTransactionQueueAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIntegrationTransactionQueueDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIntegrationTransactionQueueDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIntegrationTransactionQueueDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPIntegrationTransactionQueueDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CustomerPackages": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing CustomerPackages according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPCustomerPackages_GetAllCustomerPackageAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerPackageDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerPackageDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerPackageDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPCustomerPackageDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single CustomerPackage record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCustomerPackages_PutCustomerPackageAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPCustomerPackageDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPCustomerPackageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPCustomerPackageDto" } } }, "required": true, "x-bodyName": "customerPackage" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/CustomerPackages/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single CustomerPackage record for a given Unique Id.", "description": "This endpoint retrieves a CustomerPackage based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPCustomerPackages_GetCustomerPackageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single CustomerPackage record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPCustomerPackages_DeleteCustomerPackageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPCustomerPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightPackageLinks": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing FreightPackageLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFreightPackageLinks_GetAllFreightPackageLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single FreightPackageLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightPackageLinks_PutFreightPackageLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPFreightPackageLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPFreightPackageLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPFreightPackageLinkDto" } } }, "required": true, "x-bodyName": "freightPackageLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightPackageLinks/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single FreightPackageLink record for a given Unique Id.", "description": "This endpoint retrieves a FreightPackageLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFreightPackageLinks_GetFreightPackageLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single FreightPackageLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightPackageLinks_DeleteFreightPackageLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightPackageRates": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing FreightPackageRates according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFreightPackageRates_GetAllFreightPackageRateAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageRateDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageRateDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageRateDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageRateDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single FreightPackageRate record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightPackageRates_PutFreightPackageRateAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPFreightPackageRateDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPFreightPackageRateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPFreightPackageRateDto" } } }, "required": true, "x-bodyName": "freightPackageRate" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightPackageRates/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single FreightPackageRate record for a given Unique Id.", "description": "This endpoint retrieves a FreightPackageRate based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFreightPackageRates_GetFreightPackageRateAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single FreightPackageRate record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightPackageRates_DeleteFreightPackageRateAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageRateDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightPackages": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing FreightPackages according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFreightPackages_GetAllFreightPackageAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightPackageDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single FreightPackage record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightPackages_PutFreightPackageAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPFreightPackageDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPFreightPackageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPFreightPackageDto" } } }, "required": true, "x-bodyName": "freightPackage" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightPackages/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single FreightPackage record for a given Unique Id.", "description": "This endpoint retrieves a FreightPackage based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFreightPackages_GetFreightPackageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single FreightPackage record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightPackages_DeleteFreightPackageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightReferences": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing FreightReferences according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFreightReferences_GetAllFreightReferenceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightReferenceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightReferenceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightReferenceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightReferenceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single FreightReference record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightReferences_PutFreightReferenceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPFreightReferenceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPFreightReferenceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPFreightReferenceDto" } } }, "required": true, "x-bodyName": "freightReference" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightReferences/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single FreightReference record for a given Unique Id.", "description": "This endpoint retrieves a FreightReference based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFreightReferences_GetFreightReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single FreightReference record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightReferences_DeleteFreightReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightShipments": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing FreightShipments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPFreightShipments_GetAllFreightShipmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightShipmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightShipmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightShipmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPFreightShipmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single FreightShipment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightShipments_PutFreightShipmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPFreightShipmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPFreightShipmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPFreightShipmentDto" } } }, "required": true, "x-bodyName": "freightShipment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/FreightShipments/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single FreightShipment record for a given Unique Id.", "description": "This endpoint retrieves a FreightShipment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPFreightShipments_GetFreightShipmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single FreightShipment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPFreightShipments_DeleteFreightShipmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPFreightShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentComponents": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShipmentComponents according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipmentComponents_GetAllShipmentComponentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentComponentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentComponentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentComponentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentComponentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShipmentComponent record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentComponents_PutShipmentComponentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentComponentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentComponentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentComponentDto" } } }, "required": true, "x-bodyName": "shipmentComponent" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentComponents/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShipmentComponent record for a given Unique Id.", "description": "This endpoint retrieves a ShipmentComponent based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipmentComponents_GetShipmentComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShipmentComponent record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentComponents_DeleteShipmentComponentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentComponentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentFreightLinks/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShipmentFreightLink record for a given Unique Id.", "description": "This endpoint retrieves a ShipmentFreightLink based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipmentFreightLinks_GetShipmentFreightLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShipmentFreightLink record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentFreightLinks_DeleteShipmentFreightLinkAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentFreightLinks": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShipmentFreightLinks according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipmentFreightLinks_GetAllShipmentFreightLinkAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightLinkDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightLinkDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightLinkDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightLinkDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShipmentFreightLink record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentFreightLinks_PutShipmentFreightLinkAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentFreightLinkDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentFreightLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentFreightLinkDto" } } }, "required": true, "x-bodyName": "shipmentFreightLink" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightLinkDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentFreightReferences": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShipmentFreightReferences according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipmentFreightReferences_GetAllShipmentFreightReferenceAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightReferenceDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightReferenceDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightReferenceDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentFreightReferenceDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShipmentFreightReference record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentFreightReferences_PutShipmentFreightReferenceAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentFreightReferenceDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentFreightReferenceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentFreightReferenceDto" } } }, "required": true, "x-bodyName": "shipmentFreightReference" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentFreightReferences/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShipmentFreightReference record for a given Unique Id.", "description": "This endpoint retrieves a ShipmentFreightReference based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipmentFreightReferences_GetShipmentFreightReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShipmentFreightReference record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentFreightReferences_DeleteShipmentFreightReferenceAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentFreightReferenceDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentLines": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShipmentLines according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipmentLines_GetAllShipmentLineAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentLineDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentLineDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentLineDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentLineDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShipmentLine record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentLines_PutShipmentLineAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentLineDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentLineDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentLineDto" } } }, "required": true, "x-bodyName": "shipmentLine" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentLines/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShipmentLine record for a given Unique Id.", "description": "This endpoint retrieves a ShipmentLine based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipmentLines_GetShipmentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShipmentLine record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentLines_DeleteShipmentLineAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentLineDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentPackageDetails": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShipmentPackageDetails according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipmentPackageDetails_GetAllShipmentPackageDetailAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDetailDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDetailDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDetailDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDetailDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShipmentPackageDetail record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentPackageDetails_PutShipmentPackageDetailAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentPackageDetailDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentPackageDetailDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentPackageDetailDto" } } }, "required": true, "x-bodyName": "shipmentPackageDetail" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentPackageDetails/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShipmentPackageDetail record for a given Unique Id.", "description": "This endpoint retrieves a ShipmentPackageDetail based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipmentPackageDetails_GetShipmentPackageDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShipmentPackageDetail record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentPackageDetails_DeleteShipmentPackageDetailAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDetailDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentPackages": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShipmentPackages according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipmentPackages_GetAllShipmentPackageAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentPackageDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShipmentPackage record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentPackages_PutShipmentPackageAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentPackageDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentPackageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentPackageDto" } } }, "required": true, "x-bodyName": "shipmentPackage" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShipmentPackages/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShipmentPackage record for a given Unique Id.", "description": "This endpoint retrieves a ShipmentPackage based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipmentPackages_GetShipmentPackageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShipmentPackage record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipmentPackages_DeleteShipmentPackageAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentPackageDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Shipments": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing Shipments according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShipments_GetAllShipmentAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShipmentDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single Shipment record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipments_PutShipmentAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShipmentDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShipmentDto" } } }, "required": true, "x-bodyName": "shipment" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/Shipments/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single Shipment record for a given Unique Id.", "description": "This endpoint retrieves a Shipment based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShipments_GetShipmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single Shipment record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShipments_DeleteShipmentAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShipmentDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShippingMethods": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShippingMethods according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShippingMethods_GetAllShippingMethodAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingMethodDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingMethodDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingMethodDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingMethodDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShippingMethod record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShippingMethods_PutShippingMethodAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShippingMethodDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShippingMethodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShippingMethodDto" } } }, "required": true, "x-bodyName": "shippingMethod" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShippingMethods/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShippingMethod record for a given Unique Id.", "description": "This endpoint retrieves a ShippingMethod based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShippingMethods_GetShippingMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShippingMethod record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShippingMethods_DeleteShippingMethodAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingMethodDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShippingPaymentTypes": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns all existing ShippingPaymentTypes according to the filter, order by and pagination options.", "description": "When passing the filter parameter, the following operators are supported: [eq, ne, gt, lt]. Multiple filters can be specified as separate query parameters in the format M1Field[operator]value. eg. `impPartID[eq]CLIP`. An invalid filter will return a 400 Bad Request response.\r\n\r\nWhen passing the orderBy parameter, the following operators are supported: [Asc, Desc]. The format must be M1Field[Asc],M1Field[Desc]. eg. `impPartID[Asc],impPartType[Desc]`. An invalid orderBy will return a 400 Bad Request response.\r\n\r\nCustom fields are returned in the response as their full field name, they are also filterable and sortable. The format should be `M1CustomField[operator]value`. eg. `uimpCustomField1[eq]12`.", "operationId": "ERPShippingPaymentTypes_GetAllShippingPaymentTypeAsync", "parameters": [ { "name": "pageSize", "in": "query", "description": "Specifies the number of items per page. Defaults to 1000 which is also the maximum.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Specifies the page number to retrieve. Defaults to 0, which corresponds to the first page.", "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "description": "Applies a filter to the returned data. The format should be `M1Field[operator]value`.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "orderBy", "in": "query", "description": "Specifies the sorting criteria for the returned data. The format should be `M1Field[Asc],M1Field[Desc]`.", "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPaymentTypeDto]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPaymentTypeDto]]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPaymentTypeDto]]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[IList[ERPShippingPaymentTypeDto]]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "put": { "tags": [ "ERP/SHIPPING" ], "summary": "Creates or updates a single ShippingPaymentType record.", "description": "When a record does not exist, a new record will be created. When a record exists, the record will be updated.\r\n\r\nWhen updating an existing record, all fields must be provided, even if they are not changing. Upon update, the UniqueID, Created By/Date and M1 Keys (eg. cmoOrganizationID) will not be updated.\r\n\r\nCustom fields should be sent in the request as their full field name and should be prefixed with `u`. eg. `uimpCustomField1`.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShippingPaymentTypes_PutShippingPaymentTypeAsync", "requestBody": { "description": "The fully populated {M1.API.DTOs.ERP.ERPShippingPaymentTypeDto} model.", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPShippingPaymentTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPShippingPaymentTypeDto" } } }, "required": true, "x-bodyName": "shippingPaymentType" }, "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } } } }, "201": { "description": "Created", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } }, "/api/ERP/ShippingPaymentTypes/{key}": { "get": { "tags": [ "ERP/SHIPPING" ], "summary": "Returns a single ShippingPaymentType record for a given Unique Id.", "description": "This endpoint retrieves a ShippingPaymentType based on its identifier. If the record does not exist, a 404 Not Found response will be returned.", "operationId": "ERPShippingPaymentTypes_GetShippingPaymentTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be retrieved", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } }, "delete": { "tags": [ "ERP/SHIPPING" ], "summary": "Deletes a single ShippingPaymentType record.", "description": "If the record is not found, a 404 Not Found response will be returned.\r\n\r\nIf the record is successfully deleted, a 200 OK response will be returned.\r\n\r\nIf the record is being used anywhere in the M1 system, a 400 Bad Request response will be returned.\r\n\r\nTo use this endpoint, you must have an API Key that supports writes.", "operationId": "ERPShippingPaymentTypes_DeleteShippingPaymentTypeAsync", "parameters": [ { "name": "key", "in": "path", "description": "The Unique Id of the record to be deleted", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ERPResponseMessageDto[ERPShippingPaymentTypeDto]" } } } }, "400": { "description": "BadRequest", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/json": { }, "application/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "NotFound", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } }, "415": { "description": "UnsupportedMediaType", "content": { "text/json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } }, "500": { "description": "InternalServerError", "content": { "text/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/APIResponseMessageDto" } } } } } } } }, "components": { "schemas": { "CTMPartClassesDto": { "type": "object", "properties": { "partClasses": { "type": "array", "items": { "$ref": "#/components/schemas/PartClassDto" } } } }, "APIResponseMessageDto": { "type": "object", "properties": { "description": { "type": "string" }, "status": { "type": "string" }, "payloadID": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "readOnly": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/Warning" }, "readOnly": true } } }, "CTMPartGroupsDto": { "type": "object", "properties": { "partGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PartGroupDto" } } } }, "CTMProcessDto": { "type": "object", "properties": { "processes": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessDto" } } } }, "CTMWorkCenterDto": { "type": "object", "properties": { "workCenters": { "type": "array", "items": { "$ref": "#/components/schemas/WorkCenterDto" } } } }, "CTMWarehousesDto": { "type": "object", "properties": { "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseDto" } } } }, "CTMWarehouseBinsDto": { "type": "object", "properties": { "warehouseBins": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseBinDto" } } } }, "BOMJobGuidsDto": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobGuidDto" } } } }, "CTMBOMJobMethodDto": { "type": "object", "properties": { "job": { "$ref": "#/components/schemas/BOMJobDto" }, "jobmethodassemblies": { "type": "array", "items": { "$ref": "#/components/schemas/CTMBOMJobMethodAssemblyDto" } } } }, "BOMJobDto": { "type": "object", "properties": { "jobID": { "type": "string" }, "plantID": { "type": "string" }, "productionDueDate": { "type": "string", "format": "date-time" }, "customerOrganizationID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWareHouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "jobPriorityID": { "type": "integer", "format": "int32" }, "unitOfMeasure": { "type": "string" }, "orderQuantity": { "type": "number", "format": "double" }, "inventoryQuantity": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "scrapQuantityCompleted": { "type": "number", "format": "double" }, "reworkQuantity": { "type": "number", "format": "double" }, "reworkDate": { "type": "string", "format": "date-time" }, "productionQuantity": { "type": "number", "format": "double" }, "planningComplete": { "type": "boolean" }, "scheduleComplete": { "type": "boolean" }, "productionComplete": { "type": "boolean" }, "releasedToFloor": { "type": "boolean" }, "closed": { "type": "boolean" }, "projectAreaID": { "type": "string" }, "projectID": { "type": "string" }, "partForecastPeriodID": { "type": "integer", "format": "int32" }, "partForecastYearID": { "type": "integer", "format": "int32" }, "firm": { "type": "boolean" }, "quantityShipped": { "type": "number", "format": "double" }, "quantityReceivedToInventory": { "type": "number", "format": "double" }, "nestlinkProcessed": { "type": "boolean" }, "scheduledDueDate": { "type": "string", "format": "date-time" } } }, "CTMJobDto": { "required": [ "jobID", "jobAssemblyID", "jobAssemblyLevel", "parentAssemblyID", "partID", "partRevisionID" ], "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "jobAssemblyLevel": { "type": "integer", "format": "int32" }, "parentAssemblyID": { "type": "integer", "format": "int32" }, "customerOrganizationID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWareHouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "orderQuantity": { "type": "number", "format": "double" }, "inventoryQuantity": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "reworkQuantity": { "type": "number", "format": "double" }, "productionDueDate": { "type": "string", "format": "date-time" }, "nestlinkProcessed": { "type": "boolean" } } }, "APSJobDto": { "type": "object", "properties": { "schedStartDate": { "type": "string", "format": "date-time" }, "schedEndDate": { "type": "string", "format": "date-time" }, "jobOperations": { "type": "array", "items": { "$ref": "#/components/schemas/APSJobOperationDto" } } } }, "APSResponseMessageDto[CTMAPSJobDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/CTMAPSJobDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "BOMJobAssemblyDto": { "required": [ "jobID", "jobAssemblyID", "level", "parentAssemblyID", "partID", "partShortDescription", "quantityPerParent" ], "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "partWareHouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "parentAssemblyID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partShortDescription": { "type": "string" }, "sourceMethodID": { "type": "string" }, "sourceRevisionID": { "type": "string" }, "quantityPerParent": { "type": "number", "format": "double" }, "quantityToReturn": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "orderQuantity": { "type": "number", "format": "double" }, "productionQuantity": { "type": "number", "format": "double" }, "quantityToMake": { "type": "number", "format": "double" }, "quantityToPull": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "estimatedUnitCost": { "type": "number", "format": "double" }, "overlapOperationID": { "type": "integer", "format": "int32" }, "overlapType": { "type": "integer", "format": "int32" }, "closed": { "type": "boolean" }, "scheduledDueDate": { "type": "string", "format": "date-time" } } }, "BOMJobMaterialDto": { "required": [ "jobID", "jobAssemblyID", "jobMaterialID", "partID", "partShortDescription", "quantityPerAssembly", "relatedJobOperationID" ], "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "jobMaterialID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "partShortDescription": { "type": "string" }, "quantityPerAssembly": { "type": "number", "format": "double" }, "scrapPercent": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "estimatedQuantity": { "type": "number", "format": "double" }, "estimatedUnitCost": { "type": "number", "format": "double" }, "calculatedUnitCost": { "type": "number", "format": "double" }, "firm": { "type": "boolean" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "purchaseOrderID": { "type": "string" }, "leadTime": { "type": "integer", "format": "int32" }, "minimumCharge": { "type": "number", "format": "double" }, "dueInDate": { "type": "string", "format": "date-time" }, "requiredDate": { "type": "string", "format": "date-time" }, "quantityAllocated": { "type": "number", "format": "double" }, "quantityReceived": { "type": "number", "format": "double" }, "scrapQuantityReceived": { "type": "number", "format": "double" }, "quantityToInspect": { "type": "number", "format": "double" }, "quantityToReturn": { "type": "number", "format": "double" }, "receivedComplete": { "type": "boolean" }, "purchaseToJobQuantity": { "type": "number", "format": "double" }, "pullAllFromStock": { "type": "boolean" }, "pullFromStockQuantity": { "type": "number", "format": "double" }, "closed": { "type": "boolean" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" }, "relatedJobOperationID": { "type": "integer", "format": "int32" } } }, "BOMJobOperationDto": { "required": [ "jobID", "jobAssemblyID", "jobOperationID", "operationType", "workCenterID", "processID", "processShortDescription", "standardFactor", "machineType", "quantityPerAssembly", "operationQuantity" ], "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "jobOperationID": { "type": "integer", "format": "int32" }, "operationType": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "processShortDescription": { "type": "string" }, "productionStandard": { "type": "number", "format": "double" }, "standardFactor": { "type": "string" }, "machinesToSchedule": { "type": "integer", "format": "int32" }, "machineType": { "type": "integer", "format": "int32" }, "quantityPerAssembly": { "type": "number", "format": "double" }, "quantityComplete": { "type": "number", "format": "double" }, "operationQuantity": { "type": "number", "format": "double" }, "setupRate": { "type": "number", "format": "double" }, "productionRate": { "type": "number", "format": "double" }, "overheadRate": { "type": "number", "format": "double" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "plantID": { "type": "string" }, "closed": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time" } } }, "BOMTimecardLineDto": { "required": [ "timecardID", "timecardLineID", "employeeID", "workCenterID", "timecardType" ], "type": "object", "properties": { "timecardID": { "type": "integer", "format": "int32" }, "timecardLineID": { "type": "integer", "format": "int32" }, "employeeID": { "type": "string" }, "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "jobOperationID": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "completionType": { "type": "integer", "format": "int32" }, "workType": { "type": "integer", "format": "int32" }, "timecardType": { "type": "integer", "format": "int32" }, "goodQuantity": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "reworkQuantity": { "type": "number", "format": "double" }, "actualStartTime": { "type": "string", "format": "date-time" }, "actualEndTime": { "type": "string", "format": "date-time" }, "machineHours": { "type": "number", "format": "double" }, "laborHours": { "type": "number", "format": "double" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMTimecardDto": { "required": [ "timecardID", "employeeID", "shiftID", "timecardDate" ], "type": "object", "properties": { "timecardID": { "type": "integer", "format": "int32" }, "employeeID": { "type": "string" }, "shiftID": { "type": "integer", "format": "int32" }, "timecardDate": { "type": "string", "format": "date-time" }, "actualStartTime": { "type": "string", "format": "date-time" }, "actualEndTime": { "type": "string", "format": "date-time" }, "lastEndTime": { "type": "string", "format": "date-time" }, "plantID": { "type": "string" }, "plantDepartmentID": { "type": "string" }, "postedDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BomOrganizationDto": { "type": "object", "properties": { "organizationID": { "type": "string" }, "name": { "type": "string" } } }, "CTMOrganizationContactDto": { "required": [ "organizationID", "contactID", "name" ], "type": "object", "properties": { "organizationID": { "type": "string" }, "locationID": { "type": "string" }, "contactID": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "mobileNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "correspondenceMethod": { "type": "string" }, "inactive": { "type": "boolean" }, "inactiveDate": { "type": "string", "format": "date-time" }, "easyorderenabled": { "type": "boolean" }, "createdbyeasyorder": { "type": "boolean" }, "eoffirstname": { "type": "string" }, "eoinitials": { "type": "string" }, "eoprefix": { "type": "string" }, "eosurname": { "type": "string" }, "eopassword": { "type": "string" }, "eouserrole": { "type": "string" }, "eodefsupervisor": { "type": "string" }, "eosubsupervisor": { "type": "string" }, "eocustomergroup": { "type": "string" }, "eomultishipaddress": { "type": "string" }, "eoreceiveorderconfirmation": { "type": "string" }, "eoeditshippingaddress": { "type": "boolean" }, "eoreceiveemails": { "type": "boolean" }, "eohtmlmail": { "type": "boolean" }, "eoreminderofopenorders": { "type": "boolean" }, "eoorderauthorisationmessage": { "type": "boolean" }, "eoauthorisationrequest": { "type": "boolean" }, "eomaynotcreordtemp": { "type": "boolean" }, "createdby": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMOrganizationContactDto": { "required": [ "organizationID", "contactID", "name" ], "type": "object", "properties": { "organizationID": { "type": "string" }, "locationID": { "type": "string" }, "contactID": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "mobileNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "inactive": { "type": "boolean" }, "inactiveDate": { "type": "string", "format": "date-time" }, "easyorderenabled": { "type": "boolean" }, "createdbyeasyorder": { "type": "boolean" }, "eofirstname": { "type": "string" }, "eoinitials": { "type": "string" }, "eoprefix": { "type": "string" }, "eosurname": { "type": "string" }, "eopassword": { "type": "string" }, "eouserrole": { "type": "string" }, "eodefsupervisor": { "type": "string" }, "eosubsupervisor": { "type": "string" }, "eocustomergroup": { "type": "string" }, "eomultishipaddress": { "type": "string" }, "eoreceiveorderconfirmation": { "type": "string" }, "eoeditshippingaddress": { "type": "boolean" }, "eoreceiveemails": { "type": "boolean" }, "eohtmlmail": { "type": "boolean" }, "eoreminderofopenorders": { "type": "boolean" }, "eoorderauthorisationmessage": { "type": "boolean" }, "eoauthorisationrequest": { "type": "boolean" }, "eomaynotcreordtemp": { "type": "boolean" } } }, "CTMOrganizationLocationDto": { "required": [ "organizationID", "locationID", "name" ], "type": "object", "properties": { "organizationID": { "type": "string" }, "locationID": { "type": "string" }, "name": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" }, "postCode": { "type": "string" }, "country": { "type": "string" }, "phoneNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "quoteLocation": { "type": "boolean" }, "quoteContactID": { "type": "string" }, "shipLocation": { "type": "boolean" }, "shipContactID": { "type": "string" }, "arInvoiceLocation": { "type": "boolean" }, "arInvoiceContactID": { "type": "string" }, "purchaseLocation": { "type": "boolean" }, "purchaseContactID": { "type": "string" }, "apInvoiceLocation": { "type": "boolean" }, "apInvoiceContactID": { "type": "string" }, "customerTaxable": { "type": "boolean" }, "customerTaxCodeID": { "type": "string" }, "customerSecondTaxCodeID": { "type": "string" }, "customerShippingMethodID": { "type": "string" }, "customerShipPaymentTypeID": { "type": "string" }, "taxExemptNumber": { "type": "string" }, "nonTaxReasonID": { "type": "string" }, "customerPaymentTermID": { "type": "string" }, "currencyRateID": { "type": "string" }, "supplierPaymentTermID": { "type": "string" }, "supplierShippingMethodID": { "type": "string" }, "inactive": { "type": "boolean" }, "inactiveDate": { "type": "string", "format": "date-time" }, "customerShippingCarrier": { "type": "string" }, "upsAcctNumber": { "type": "string" }, "upsWsBillingOption": { "type": "string" }, "ups3rdPartyOrganizationID": { "type": "string" }, "ups3rdPartyLocationID": { "type": "string" }, "residentialAddress": { "type": "boolean" }, "fedExAccountNumber": { "type": "string" }, "fedEx3rdPartyOrganizationID": { "type": "string" }, "fedExBillingOption": { "type": "string" }, "creditCheckForLocation": { "type": "boolean" }, "customerCreditLimit": { "type": "number", "format": "double" }, "creditHold": { "type": "boolean" }, "countryCode": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "avalaraUseCodes": { "type": "string" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMOrganizationLocationDto": { "required": [ "organizationID", "locationID", "name" ], "type": "object", "properties": { "organizationID": { "type": "string" }, "locationID": { "type": "string" }, "name": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" }, "postCode": { "type": "string" }, "country": { "type": "string" }, "phoneNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "quoteLocation": { "type": "boolean" }, "shipLocation": { "type": "boolean" }, "arInvoiceLocation": { "type": "boolean" }, "customerTaxable": { "type": "boolean" }, "customerTaxCodeID": { "type": "string" }, "customerSecondTaxCodeID": { "type": "string" }, "customerShippingMethodID": { "type": "string" }, "customerShipPaymentTypeID": { "type": "string" }, "customerShippingCarrier": { "type": "string" }, "upsAcctNumber": { "type": "string" }, "fedExAccountNumber": { "type": "string" }, "countryCode": { "type": "string" } } }, "BOMPartDto": { "required": [ "partID", "shortDescription", "partType" ], "type": "object", "properties": { "partID": { "type": "string" }, "shortDescription": { "type": "string" }, "partType": { "type": "integer", "format": "int32" }, "partClassID": { "type": "string" }, "partGroupID": { "type": "string" }, "longDescription": { "type": "string" }, "deliveryType": { "type": "integer", "format": "int32" }, "buyForInventory": { "type": "boolean" }, "nonStockedItem": { "type": "boolean" } } }, "CTMBOMPartRevisionDto": { "required": [ "part" ], "type": "object", "properties": { "part": { "$ref": "#/components/schemas/BOMPartDto" }, "partRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartRevisionDto" } } } }, "BOMPartAssemblyDto": { "required": [ "methodID", "methodAssemblyID", "level", "useMethod", "parentAssemblyID", "partID", "partShortDescription" ], "type": "object", "properties": { "methodID": { "type": "string" }, "methodRevisionID": { "type": "string" }, "methodAssemblyID": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "useMethod": { "type": "boolean" }, "parentAssemblyID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partShortDescription": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "quantityPerParent": { "type": "number", "format": "double" }, "overlapOperationID": { "type": "integer", "format": "int32" }, "partLongDescription": { "type": "string" } } }, "BOMPartOperationDto": { "required": [ "methodID", "methodAssemblyID", "methodOperationID", "operationType", "workCenterID", "processID", "processShortDescription", "standardFactor", "machineType", "quantityPerAssembly" ], "type": "object", "properties": { "methodID": { "type": "string" }, "methodRevisionID": { "type": "string" }, "methodAssemblyID": { "type": "integer", "format": "int32" }, "methodOperationID": { "type": "integer", "format": "int32" }, "operationType": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "processShortDescription": { "type": "string" }, "productionStandard": { "type": "number", "format": "double" }, "standardFactor": { "type": "string" }, "machinesToSchedule": { "type": "integer", "format": "int32" }, "machineType": { "type": "integer", "format": "int32" }, "quantityPerAssembly": { "type": "number", "format": "double" } } }, "BOMPartMaterialDto": { "required": [ "methodID", "methodAssemblyID", "methodMaterialID", "partID", "partShortDescription" ], "type": "object", "properties": { "methodID": { "type": "string" }, "methodRevisionID": { "type": "string" }, "methodAssemblyID": { "type": "integer", "format": "int32" }, "methodMaterialID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "relatedPartOperationID": { "type": "integer", "format": "int32" }, "partShortDescription": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "estimatedUnitCost": { "type": "number", "format": "double" }, "leadTime": { "type": "integer", "format": "int32" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "quantityPerParent": { "type": "number", "format": "double" }, "manualPart": { "type": "boolean" }, "partLongDescription": { "type": "string" }, "backflush": { "type": "boolean" }, "scrapQuantity": { "type": "number", "format": "double" }, "scrapPercent": { "type": "number", "format": "double" } } }, "BOMResponseMessageDto[BOMPartMaterialDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } }, "CTMBOMPartMethodDto": { "type": "object", "properties": { "part": { "$ref": "#/components/schemas/BOMPartDto" }, "partRevision": { "$ref": "#/components/schemas/BOMPartRevisionDto" }, "partAssemblies": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMethodAssemblyDto" } } } }, "CTMBOMPartMethodGuidsDto": { "type": "object", "properties": { "partMethodGuids": { "type": "array", "items": { "$ref": "#/components/schemas/CTMBOMPartMethodGuidDto" } } } }, "BOMPartBinDetailDto": { "required": [ "partID" ], "type": "object", "properties": { "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partBinID": { "type": "string" }, "partBinDetailID": { "type": "integer", "format": "int32" }, "transactionDate": { "type": "string", "format": "date-time" }, "quantityType": { "type": "integer", "format": "int32" }, "originalQuantity": { "type": "number", "format": "double" }, "remainingQuantity": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "sourceTableName": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" }, "warehouseID": { "type": "string" } } }, "BOMQuoteAssemblyDto": { "required": [ "quoteID", "quoteLineID", "quoteAssemblyID", "level", "partID", "partRevisionID", "partShortDescription", "quantityPerParent" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "quoteAssemblyID": { "type": "integer", "format": "int32" }, "parentAssemblyID": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "sourceMethodID": { "type": "string" }, "sourceRevisionID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "partShortDescription": { "type": "string" }, "quantityPerParent": { "type": "number", "format": "double" }, "closed": { "type": "boolean" }, "pullAllFromStock": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMCreateQuoteAssemblyDto": { "required": [ "quoteID", "quoteLineID", "quoteAssemblyID", "parentAssemblyID", "level", "partID", "unitOfMeasure", "quantityPerParent" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "quoteAssemblyID": { "type": "integer", "format": "int32" }, "parentAssemblyID": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "quantityPerParent": { "type": "number", "format": "double" }, "pullAllFromStock": { "type": "boolean" } } }, "BOMQuoteLineDto": { "required": [ "quoteID", "quoteLineID", "partID", "partRevisionID", "partShortDescription", "quoteMarkupType" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "partGroupID": { "type": "string" }, "partShortDescription": { "type": "string" }, "orgPartShortDescription": { "type": "string" }, "resolutionReasonID": { "type": "string" }, "quoteMarkupType": { "type": "integer", "format": "int32" }, "purchaseToOrder": { "type": "boolean" }, "purchaseUnitCostForeign": { "type": "number", "format": "double" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "firm": { "type": "boolean" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "closed": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "CTMBOMQuoteLineDto": { "required": [ "quote" ], "type": "object", "properties": { "quote": { "$ref": "#/components/schemas/BOMQuoteDto" }, "quoteLines": { "type": "array", "items": { "$ref": "#/components/schemas/BOMQuoteLineDto" } } } }, "BOMCreateQuoteLineDto": { "required": [ "quoteID", "quoteLineID", "partID", "unitOfMeasure" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "purchaseUnitCostBase": { "type": "number", "format": "double" }, "firm": { "type": "boolean" } } }, "BOMQuoteMaterialDto": { "required": [ "quoteID", "quoteLineID", "quoteMaterialID", "partID", "partRevisionID", "partWarehouseLocationID", "partBinID", "partShortDescription" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "quoteAssemblyID": { "type": "integer", "format": "int32" }, "quoteMaterialID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "partShortDescription": { "type": "string" }, "quantityPerAssembly": { "type": "number", "format": "double" }, "scrapPercent": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "estimatedUnitCost": { "type": "number", "format": "double" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "leadTime": { "type": "integer", "format": "int32" }, "minimumCharge": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "closed": { "type": "boolean" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMCreateQuoteMaterialDto": { "required": [ "quoteID", "quoteLineID", "quoteMaterialID", "partID", "unitOfMeasure" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "quoteAssemblyID": { "type": "integer", "format": "int32" }, "quoteMaterialID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "quantityPerAssembly": { "type": "number", "format": "double" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" } } }, "BOMQuoteOperationDto": { "required": [ "quoteID", "quoteLineID", "quoteAssemblyID", "quoteOperationID", "operationType", "workCenterID", "processID", "processShortDescription", "quantityPerAssembly", "standardFactor" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "quoteAssemblyID": { "type": "integer", "format": "int32" }, "quoteOperationID": { "type": "integer", "format": "int32" }, "operationType": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "processShortDescription": { "type": "string" }, "processLongDescriptionRtf": { "type": "string" }, "processLongDescriptionText": { "type": "string" }, "quantityPerAssembly": { "type": "number", "format": "double" }, "queueTime": { "type": "number", "format": "double" }, "setupHours": { "type": "number", "format": "double" }, "moveTime": { "type": "number", "format": "double" }, "quotingRate": { "type": "number", "format": "double" }, "setupRate": { "type": "number", "format": "double" }, "productionRate": { "type": "number", "format": "double" }, "overheadRate": { "type": "number", "format": "double" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "standardFactor": { "type": "string" }, "productionStandard": { "type": "number", "format": "double" }, "closed": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMQuoteQuantityDto": { "required": [ "quoteID", "quoteLineID", "quoteQuantityID", "quoteQuantity", "quoteMarkupType" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "quoteLineID": { "type": "integer", "format": "int32" }, "quoteQuantityID": { "type": "integer", "format": "int32" }, "quoteQuantity": { "type": "number", "format": "double" }, "scrapPercent": { "type": "number", "format": "double" }, "totalRunQuantity": { "type": "number", "format": "double" }, "quoteMarkupType": { "type": "integer", "format": "int32" }, "purchaseToOrder": { "type": "boolean" }, "setupHours": { "type": "number", "format": "double" }, "productionHours": { "type": "number", "format": "double" }, "materialCost": { "type": "number", "format": "double" }, "materialMarkupPercent": { "type": "number", "format": "double" }, "materialPrice": { "type": "number", "format": "double" }, "subcontractPrice": { "type": "number", "format": "double" }, "laborCost": { "type": "number", "format": "double" }, "laborMarkupPercent": { "type": "number", "format": "double" }, "laborPrice": { "type": "number", "format": "double" }, "overheadCost": { "type": "number", "format": "double" }, "overheadMarkupPercent": { "type": "number", "format": "double" }, "overheadPrice": { "type": "number", "format": "double" }, "quotingPrice": { "type": "number", "format": "double" }, "purchaseUnitCostBase": { "type": "number", "format": "double" }, "purchaseToOrderCost": { "type": "number", "format": "double" }, "purToOrderMarkupPercent": { "type": "number", "format": "double" }, "purchaseToOrderPrice": { "type": "number", "format": "double" }, "additionalCostAmount": { "type": "number", "format": "double" }, "additionalMarkupPercent": { "type": "number", "format": "double" }, "additionalCostPrice": { "type": "number", "format": "double" }, "totalCost": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" }, "totalUnitCost": { "type": "number", "format": "double" }, "totalMarkupPercent": { "type": "number", "format": "double" }, "totalUnitPrice": { "type": "number", "format": "double" }, "calculatedUnitPrice": { "type": "number", "format": "double" }, "fullRevisedUnitPriceForeign": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "unitDiscountForeign": { "type": "number", "format": "double" }, "revisedUnitPriceForeign": { "type": "number", "format": "double" }, "additionalChargeForeign": { "type": "number", "format": "double" }, "additionalChargeDescription": { "type": "string" }, "leadTime": { "type": "string" }, "closed": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMQuoteDto": { "required": [ "quoteID", "customerOrganizationID", "quoterEmployeeID", "dueDate" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "customerOrganizationID": { "type": "string" }, "plantID": { "type": "string" }, "quoterEmployeeID": { "type": "string" }, "quoteDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "projectID": { "type": "string" }, "closed": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date-time" }, "paymentTermID": { "type": "string" }, "shippingMethodID": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMCreateQuoteDto": { "required": [ "quoteID", "customerOrganizationID", "shipOrganizationID" ], "type": "object", "properties": { "quoteID": { "type": "string" }, "customerOrganizationID": { "type": "string" }, "shipOrganizationID": { "type": "string" }, "quoterEmployeeID": { "type": "string" }, "currencyRateID": { "type": "string" } } }, "BOMSalesOrderDto": { "required": [ "salesOrderID", "customerOrganizationID", "shipOrganizationID", "orderDate", "status" ], "type": "object", "properties": { "salesOrderID": { "type": "string" }, "customerOrganizationID": { "type": "string" }, "shipOrganizationID": { "type": "string" }, "customerPo": { "type": "string" }, "plantID": { "type": "string" }, "plantDepartmentID": { "type": "string" }, "shipLocationID": { "type": "string" }, "shipContactID": { "type": "string" }, "arInvoiceLocationID": { "type": "string" }, "arInvoiceContactID": { "type": "string" }, "paymentTermID": { "type": "string" }, "currencyRateID": { "type": "string" }, "exchangeRate": { "type": "number", "format": "double" }, "fullOrderSubtotalBase": { "type": "number", "format": "double" }, "requestedShipDate": { "type": "string", "format": "date-time" }, "orderDate": { "type": "string", "format": "date-time" }, "orderTotalBase": { "type": "number", "format": "double" }, "orderTotalForeign": { "type": "number", "format": "double" }, "status": { "type": "integer", "format": "int32" }, "customRate": { "type": "boolean" }, "closed": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date-time" }, "freightAmountBase": { "type": "number", "format": "double" }, "freightAmountForeign": { "type": "number", "format": "double" }, "freightTaxAmountBase": { "type": "number", "format": "double" }, "freightTaxAmountForeign": { "type": "number", "format": "double" }, "freightTaxCodeID": { "type": "string" }, "freightTotalBase": { "type": "number", "format": "double" }, "freightTotalForeign": { "type": "number", "format": "double" }, "orderSubtotalBase": { "type": "number", "format": "double" }, "orderSubTotalForeign": { "type": "number", "format": "double" }, "orderTaxAmountBase": { "type": "number", "format": "double" }, "orderTaxAmountForeign": { "type": "number", "format": "double" }, "shippingMethodID": { "type": "string" }, "shippingPaymentTypeID": { "type": "string" }, "totalOrderWeight": { "type": "number", "format": "double" } } }, "BOMMaterialIssueLineDto": { "required": [ "materialIssueID", "materialIssueLineID", "issueType", "partID", "partRevisionID", "partWarehouseLocationID", "partBinID" ], "type": "object", "properties": { "materialIssueID": { "type": "string" }, "materialIssueLineID": { "type": "integer", "format": "int32" }, "issueType": { "type": "integer", "format": "int32" }, "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "createJobSeq": { "type": "boolean" }, "jobMaterialID": { "type": "integer", "format": "int32" }, "jobType": { "type": "integer", "format": "int32" }, "estimatedQuantity": { "type": "number", "format": "double" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jobOpenQuantity": { "type": "number", "format": "double" }, "issueComplete": { "type": "boolean" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "invIssueQuantity": { "type": "number", "format": "double" }, "invScrapQuantity": { "type": "number", "format": "double" }, "reference": { "type": "string" }, "heatLot": { "type": "string" }, "miscIssueReasonID": { "type": "string" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "jobMatScrapQuantity": { "type": "number", "format": "double" }, "jobAsmScrapQuantity": { "type": "number", "format": "double" }, "jobAsmIssueQuantity": { "type": "number", "format": "double" }, "jobMatIssueQuantity": { "type": "number", "format": "double" }, "jobMatReturnScrapQuantity": { "type": "number", "format": "double" }, "jobMatReturnIssueQuantity": { "type": "number", "format": "double" }, "reverseMaterialIssueID": { "type": "string" }, "reverseMaterialIssueLineID": { "type": "integer", "format": "int32" }, "reversed": { "type": "boolean" }, "kitPart": { "type": "boolean" }, "posted": { "type": "boolean" }, "longDescriptionText": { "type": "string" }, "rowVersion": { "type": "string", "format": "byte" }, "plantID": { "type": "string" }, "quantityAllocated": { "type": "number", "format": "double" }, "quantityOnHand": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } } }, "CTMBOMMaterialIssueLineDto": { "required": [ "materialIssue" ], "type": "object", "properties": { "materialIssue": { "$ref": "#/components/schemas/BOMMaterialIssueDto" }, "materialIssueLines": { "type": "array", "items": { "$ref": "#/components/schemas/BOMMaterialIssueLineDto" } } } }, "BOMMaterialIssueDto": { "type": "object", "properties": { "materialIssueID": { "type": "string" }, "materialIssueDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "postedDate": { "type": "string", "format": "date-time" }, "posted": { "type": "boolean" }, "reversalEntry": { "type": "boolean" }, "reversed": { "type": "boolean" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMMfgReceiptDto": { "required": [ "receiptType", "receiptDate", "partID", "partRevisionID", "partWarehouseLocationID", "partBinID" ], "type": "object", "properties": { "mfgReceiptID": { "type": "string" }, "receiptType": { "type": "integer", "format": "int32" }, "receiptDate": { "type": "string", "format": "date-time" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "posted": { "type": "boolean" }, "postedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "miscInvQuantityReceived": { "type": "number", "format": "double" }, "inventoryQuantityReceived": { "type": "number", "format": "double" }, "jobOprQuantityReceived": { "type": "number", "format": "double" }, "jobAsmQuantityReceived": { "type": "number", "format": "double" }, "jobMatQuantityReceived": { "type": "number", "format": "double" }, "reference": { "type": "string" }, "heatLot": { "type": "string" } } }, "BOMReceiptDto": { "required": [ "receiptID", "receiptDate", "supplierOrganizationID" ], "type": "object", "properties": { "receiptID": { "type": "string" }, "receiptDate": { "type": "string", "format": "date-time" }, "plantDepartmentID": { "type": "string" }, "plantID": { "type": "string" }, "deliveryDocket": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "purchaseLocationID": { "type": "string" }, "apInvoiceLocationID": { "type": "string" }, "apInvoiceContactID": { "type": "string" }, "shippingMethodID": { "type": "string" }, "receiptSubtotal": { "type": "number", "format": "double" }, "freightCharge": { "type": "number", "format": "double" }, "receiptTotal": { "type": "number", "format": "double" }, "projectID": { "type": "string" }, "currencyRateID": { "type": "string" }, "exchangeRate": { "type": "number", "format": "double" }, "nestlinkProcessed": { "type": "boolean" }, "customRate": { "type": "boolean" }, "reversalEntry": { "type": "boolean" }, "reversed": { "type": "boolean" }, "postedToGl": { "type": "boolean" }, "postedDate": { "type": "string", "format": "date-time" }, "closed": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" } } }, "BOMReceiptLineDto": { "type": "object", "properties": { "receiptLineID": { "type": "integer", "format": "int32" }, "receiptID": { "type": "string" }, "purchaseOrderID": { "type": "string" }, "purchaseOrderLineID": { "type": "integer", "format": "int32" }, "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "jobType": { "type": "integer", "format": "int32" }, "jobMaterialID": { "type": "integer", "format": "int32" }, "jobOperationID": { "type": "integer", "format": "int32" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "orgPartID": { "type": "string" }, "orgPartShortDescription": { "type": "string" }, "description": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "purchaseQuantityReceived": { "type": "number", "format": "double" }, "purchaseUnitOfMeasure": { "type": "string" }, "purchaseUnitCost": { "type": "number", "format": "double" }, "setupCharge": { "type": "number", "format": "double" }, "conversionFactor": { "type": "number", "format": "double" }, "inventoryUnitOfMeasure": { "type": "string" }, "inventoryUnitCost": { "type": "number", "format": "double" }, "poReceivedComplete": { "type": "boolean" }, "jobReceivedComplete": { "type": "boolean" }, "requiresInspection": { "type": "boolean" }, "reference": { "type": "string" }, "heatLot": { "type": "string" }, "projectID": { "type": "string" }, "projectAreaID": { "type": "string" }, "closed": { "type": "boolean" }, "postedToGl": { "type": "boolean" }, "reversed": { "type": "boolean" }, "reverseReceiptID": { "type": "string" }, "reverseReceiptLineID": { "type": "integer", "format": "int32" }, "jobOprQuantityReceived": { "type": "number", "format": "double" }, "jobMatQuantityReceived": { "type": "number", "format": "double" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" } } }, "ERPResponseMessageDto[IList[ERPLaserCalculatorLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLaserCalculatorLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLaserCalculatorLineDto": { "required": [ "cclLaserCalculatorID", "cclLaserCalculatorLineID" ], "type": "object", "properties": { "cclCreatedBy": { "type": "string" }, "cclCreatedDate": { "type": "string", "format": "date-time" }, "cclCutTime": { "minimum": 0, "type": "number", "format": "double" }, "cclDescription": { "type": "string" }, "cclUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cclLaserCalculatorID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccllength": { "minimum": 0, "type": "number", "format": "double" }, "cclQuantity": { "minimum": 0, "type": "number", "format": "double" }, "cclRate": { "minimum": 0, "type": "number", "format": "double" }, "cclRowVersion": { "type": "integer", "format": "int64" }, "cclLaserCalculatorLineID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "cclWidth": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPLaserCalculatorLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLaserCalculatorLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLaserCalculatorDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLaserCalculatorDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLaserCalculatorDto": { "required": [ "ccpLaserCalculatorID" ], "type": "object", "properties": { "ccpLaserCalculatorID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccpCreatedBy": { "type": "string" }, "ccpCreatedDate": { "type": "string", "format": "date-time" }, "ccpdescription": { "type": "string" }, "ccpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccpExternalFeed": { "minimum": 0, "type": "number", "format": "double" }, "ccpHoleCutTime": { "minimum": 0, "type": "number", "format": "double" }, "ccpObround": { "type": "boolean" }, "ccpOther": { "type": "boolean" }, "ccpRectangle": { "type": "boolean" }, "ccpRound": { "type": "boolean" }, "ccpSquare": { "type": "boolean" }, "ccpLaserMaterialTypeID": { "type": "string" }, "ccpLeadInOut": { "minimum": 0, "type": "number", "format": "double" }, "ccpLeadInOutFeed": { "minimum": 0, "type": "number", "format": "double" }, "ccpLeadInOutTime": { "minimum": 0, "type": "number", "format": "double" }, "ccplength": { "minimum": 0, "type": "number", "format": "double" }, "ccpMeasurementType": { "type": "string" }, "ccpNumberOfHoles": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccpPartPerimeter": { "minimum": 0, "type": "number", "format": "double" }, "ccpPerimeterCutTime": { "minimum": 0, "type": "number", "format": "double" }, "ccpPiercedHoles": { "minimum": 0, "type": "number", "format": "double" }, "ccpPierceTime": { "minimum": 0, "type": "number", "format": "double" }, "ccpQuantity": { "minimum": 0, "type": "number", "format": "double" }, "ccpRate": { "minimum": 0, "type": "number", "format": "double" }, "ccpRowVersion": { "type": "integer", "format": "int64" }, "ccpThickness": { "minimum": 0, "type": "number", "format": "double" }, "ccpTotalCutTime": { "minimum": 0, "type": "number", "format": "double" }, "ccpTotalLeadInOutTime": { "minimum": 0, "type": "number", "format": "double" }, "ccpTotalPierceTime": { "minimum": 0, "type": "number", "format": "double" }, "ccpWidth": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPLaserCalculatorDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLaserCalculatorDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPunchCalculatorDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPunchCalculatorDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPunchCalculatorDto": { "required": [ "ccuPunchCalculatorId" ], "type": "object", "properties": { "ccuPunchCalculatorId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccuCreatedBy": { "type": "string" }, "ccuCreatedDate": { "type": "string", "format": "date-time" }, "ccuUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccuHitRate": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuHitsPerPart": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuPartsPerHour": { "minimum": 0, "type": "number", "format": "double" }, "ccuPartsPerSheet": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuRepositions": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuRepositionTime": { "minimum": 0, "type": "number", "format": "double" }, "ccuRepositionTimeSec": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuRowVersion": { "type": "integer", "format": "int64" }, "ccuSheetLoadTime": { "minimum": 0, "type": "number", "format": "double" }, "ccuSheetLoadTimeSec": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuSheetsPerHour": { "minimum": 0, "type": "number", "format": "double" }, "ccuTimeToPiece": { "minimum": 0, "type": "number", "format": "double" }, "ccuToolChangeTimeSec": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuToolChangeTimeTotal": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuTools": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuTotalTimeMinutes": { "minimum": 0, "type": "number", "format": "double" }, "ccuTotalTimeSeconds": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "ccuTurns": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPPunchCalculatorDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPunchCalculatorDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSheetCalculatorDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSheetCalculatorDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSheetCalculatorDto": { "required": [ "ccsSheetCalculatorID" ], "type": "object", "properties": { "ccs0Rotation": { "minimum": 0, "type": "number", "format": "double" }, "ccs90Rotation": { "minimum": 0, "type": "number", "format": "double" }, "ccsSheetCalculatorID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccsCreatedBy": { "type": "string" }, "ccsCreatedDate": { "type": "string", "format": "date-time" }, "ccsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ccsGrain": { "type": "boolean" }, "ccsMeasurementType": { "type": "string" }, "ccsPartSizeX": { "minimum": 0, "type": "number", "format": "double" }, "ccsPartSizeY": { "minimum": 0, "type": "number", "format": "double" }, "ccsPartSpacingX": { "minimum": 0, "type": "number", "format": "double" }, "ccsPartSpacingY": { "minimum": 0, "type": "number", "format": "double" }, "ccsRowVersion": { "type": "integer", "format": "int64" }, "ccsSheetSizeX": { "minimum": 0, "type": "number", "format": "double" }, "ccsSheetSizeY": { "minimum": 0, "type": "number", "format": "double" }, "ccsTotalTrimX": { "minimum": 0, "type": "number", "format": "double" }, "ccsTotalTrimY": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPSheetCalculatorDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSheetCalculatorDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartRuleDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartRuleDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartRuleDto": { "required": [ "pcrField", "pcrMethodID", "pcrMethodType" ], "type": "object", "properties": { "pcrCode": { "type": "string" }, "pcrCreatedBy": { "type": "string" }, "pcrCreatedDate": { "type": "string", "format": "date-time" }, "pcrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pcrField": { "type": "string" }, "pcrMethodAssemblyID": { "type": "integer", "format": "int32" }, "pcrMethodID": { "type": "string" }, "pcrMethodMaterialID": { "type": "integer", "format": "int32" }, "pcrMethodOperationID": { "type": "integer", "format": "int32" }, "pcrMethodRevisionID": { "type": "string" }, "pcrMethodType": { "type": "integer", "format": "int32" }, "pcrProcessSequence": { "type": "integer", "format": "int32" }, "pcrRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPartRuleDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartRuleDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCallLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCallLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCallLineDto": { "required": [ "kblAddedByEmployeeID", "kblAddedDate", "kblCallID", "kblContactMethodID", "kblCallLineID", "kblShortDescription" ], "type": "object", "properties": { "kblAddedByEmployeeID": { "type": "string" }, "kblAddedDate": { "type": "string", "format": "date-time" }, "kblCallID": { "type": "string" }, "kblContactMethodID": { "type": "string" }, "kblCreatedBy": { "type": "string" }, "kblCreatedDate": { "type": "string", "format": "date-time" }, "kblUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kblExtraTime": { "minimum": 0, "type": "number", "format": "double" }, "kblBillable": { "type": "boolean" }, "kblCreatedFromMobile": { "type": "boolean" }, "kblInbound": { "type": "boolean" }, "kblInternalOnly": { "type": "boolean" }, "kblLongDescriptionRtf": { "type": "string" }, "kblLongDescriptionText": { "type": "string" }, "kblRowVersion": { "type": "integer", "format": "int64" }, "kblCallLineID": { "type": "integer", "format": "int32" }, "kblShortDescription": { "type": "string" }, "kblTimeSpent": { "minimum": 0, "type": "number", "format": "double" }, "kblTotalTime": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPCallLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCallLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCallMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCallMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCallMemoDto": { "required": [ "kbkCallID", "kbkMemoDate", "kbkCallMemoID", "kbkShortDescription" ], "type": "object", "properties": { "kbkCallID": { "type": "string" }, "kbkCreatedBy": { "type": "string" }, "kbkCreatedDate": { "type": "string", "format": "date-time" }, "kbkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbkLongDescriptionRtf": { "type": "string" }, "kbkLongDescriptionText": { "type": "string" }, "kbkMemoDate": { "type": "string", "format": "date-time" }, "kbkRowVersion": { "type": "integer", "format": "int64" }, "kbkCallMemoID": { "type": "integer", "format": "int32" }, "kbkShortDescription": { "type": "string" }, "kbkShowInCalls": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPCallMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCallMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCallDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCallDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCallDto": { "required": [ "kbpCallTypeID", "kbpCallID", "kbpOpenedByEmployeeID", "kbpOpenedDate", "kbpOrganizationID", "kbpShortDescription", "kbpStatus" ], "type": "object", "properties": { "kbpAcceptedDate": { "type": "string", "format": "date-time" }, "kbpApInvoiceID": { "type": "string" }, "kbpArInvoiceContactID": { "type": "string" }, "kbpArInvoiceID": { "type": "string" }, "kbpArInvoiceLocationID": { "type": "string" }, "kbpArInvoiceOrganizationID": { "type": "string" }, "kbpAssignedDate": { "type": "string", "format": "date-time" }, "kbpAssignedToEmployeeID": { "type": "string" }, "kbpCallTypeID": { "type": "string" }, "kbpClosedByEmployeeID": { "type": "string" }, "kbpClosedDate": { "type": "string", "format": "date-time" }, "kbpCallID": { "type": "string" }, "kbpContactID": { "type": "string" }, "kbpContactMethodID": { "type": "string" }, "kbpCreatedBy": { "type": "string" }, "kbpCreatedDate": { "type": "string", "format": "date-time" }, "kbpCurrencyRateID": { "type": "string" }, "kbpDmrClaimID": { "type": "string" }, "kbpDueDate": { "type": "string", "format": "date-time" }, "kbpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "kbpExtraTime": { "minimum": 0, "type": "number", "format": "double" }, "kbpBillable": { "type": "boolean" }, "kbpCreatedFromMobile": { "type": "boolean" }, "kbpCustomRate": { "type": "boolean" }, "kbpFieldServiceCall": { "type": "boolean" }, "kbpFieldServiceJobCreated": { "type": "boolean" }, "kbpInbound": { "type": "boolean" }, "kbpInternalOnly": { "type": "boolean" }, "kbpInvoicedComplete": { "type": "boolean" }, "kbpPublished": { "type": "boolean" }, "kbpJobID": { "type": "string" }, "kbpLeadID": { "type": "string" }, "kbpLocationID": { "type": "string" }, "kbpLongDescriptionRtf": { "type": "string" }, "kbpLongDescriptionText": { "type": "string" }, "kbpMethodPartID": { "type": "string" }, "kbpMethodRevisionID": { "type": "string" }, "kbpOpenedByEmployeeID": { "type": "string" }, "kbpOpenedDate": { "type": "string", "format": "date-time" }, "kbpOrganizationID": { "type": "string" }, "kbpOrgPartID": { "type": "string" }, "kbpPartGroupID": { "type": "string" }, "kbpPartID": { "type": "string" }, "kbpPartRevisionID": { "type": "string" }, "kbpPartShortDescription": { "type": "string" }, "kbpPhoneNumber": { "type": "string" }, "kbpPriorityID": { "type": "integer", "format": "int32" }, "kbpProjectAreaID": { "type": "string" }, "kbpProjectID": { "type": "string" }, "kbpPurchaseOrderID": { "type": "string" }, "kbpQuoteID": { "type": "string" }, "kbpReasonID": { "type": "string" }, "kbpReceiptID": { "type": "string" }, "kbpRfqID": { "type": "string" }, "kbpRmaClaimID": { "type": "string" }, "kbpRowVersion": { "type": "integer", "format": "int64" }, "kbpSalesOrderID": { "type": "string" }, "kbpSerialNumberID": { "type": "string" }, "kbpShipmentID": { "type": "string" }, "kbpShortDescription": { "type": "string" }, "kbpStatus": { "type": "string" }, "kbpSubTotalTime": { "minimum": 0, "type": "number", "format": "double" }, "kbpTemplateFile": { "type": "string" }, "kbpTimeSpent": { "minimum": 0, "type": "number", "format": "double" }, "kbpTotalTime": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPCallDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCallDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCallTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCallTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPCallTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCallTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPContactGroupDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPContactGroupDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPContactGroupDto": { "required": [ "cmgContactGroupID", "cmgDescription" ], "type": "object", "properties": { "cmgContactGroupID": { "type": "string" }, "cmgCreatedBy": { "type": "string" }, "cmgCreatedDate": { "type": "string", "format": "date-time" }, "cmgDescription": { "type": "string" }, "cmgUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmgRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPContactGroupDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPContactGroupDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPContactMethodDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPContactMethodDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPContactMethodDto": { "required": [ "kbcContactMethodID", "kbcDescription" ], "type": "object", "properties": { "kbcContactMethodID": { "type": "string" }, "kbcCreatedBy": { "type": "string" }, "kbcCreatedDate": { "type": "string", "format": "date-time" }, "kbcDescription": { "type": "string" }, "kbcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbcRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPContactMethodDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPContactMethodDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPContactTitleDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPContactTitleDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPContactTitleDto": { "required": [ "cmeContactTitleID", "cmeDescription" ], "type": "object", "properties": { "cmeContactTitleID": { "type": "string" }, "cmeCreatedBy": { "type": "string" }, "cmeCreatedDate": { "type": "string", "format": "date-time" }, "cmeDescription": { "type": "string" }, "cmeUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmeRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPContactTitleDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPContactTitleDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCountyCodeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCountyCodeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCountyCodeDto": { "required": [ "xccCountyCodeID" ], "type": "object", "properties": { "xccCountyCodeID": { "type": "string" }, "xccCounty": { "type": "string" }, "xccCountyCode": { "type": "string" }, "xccCreatedBy": { "type": "string" }, "xccCreatedDate": { "type": "string", "format": "date-time" }, "xccUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xccRowVersion": { "type": "integer", "format": "int64" }, "xccStateCode": { "type": "string" } } }, "ERPResponseMessageDto[ERPCountyCodeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCountyCodeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCustomerGroupDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCustomerGroupDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCustomerGroupDto": { "required": [ "cmuCustomerGroupID", "cmuDescription" ], "type": "object", "properties": { "cmuCustomerGroupID": { "type": "string" }, "cmuCreatedBy": { "type": "string" }, "cmuCreatedDate": { "type": "string", "format": "date-time" }, "cmuDescription": { "type": "string" }, "cmuUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmuRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPCustomerGroupDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCustomerGroupDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFollowupDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFollowupDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPFollowupDto": { "required": [ "cmfAssignedToEmployeeID", "cmfFollowupID", "cmfDueDate", "cmfFollowupType", "cmfPriority", "cmfShortDescription", "cmfStatus" ], "type": "object", "properties": { "cmfApInvoiceID": { "type": "string" }, "cmfArInvoiceID": { "type": "string" }, "cmfAssetID": { "type": "string" }, "cmfAssignedToEmployeeID": { "type": "string" }, "cmfAttachedToEmployeeID": { "type": "string" }, "cmfCallID": { "type": "string" }, "cmfChangeRequestID": { "type": "string" }, "cmfFollowupID": { "type": "string" }, "cmfCompletedDate": { "type": "string", "format": "date-time" }, "cmfContactID": { "type": "string" }, "cmfCreatedBy": { "type": "string" }, "cmfCreatedDate": { "type": "string", "format": "date-time" }, "cmfDmrClaimID": { "type": "string" }, "cmfDueDate": { "type": "string", "format": "date-time" }, "cmfUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmfExchangeID": { "type": "string" }, "cmfFollowupType": { "type": "integer", "format": "int32" }, "cmfCreatedFromMobile": { "type": "boolean" }, "cmfJobID": { "type": "string" }, "cmfLeadID": { "type": "string" }, "cmfLocationID": { "type": "string" }, "cmfLongDescriptionRtf": { "type": "string" }, "cmfLongDescriptionText": { "type": "string" }, "cmfMeetingLocation": { "type": "string" }, "cmfOrganizationID": { "type": "string" }, "cmfPriority": { "type": "integer", "format": "int32" }, "cmfProjectAreaID": { "type": "string" }, "cmfProjectID": { "type": "string" }, "cmfPurchaseOrderID": { "type": "string" }, "cmfQuoteID": { "type": "string" }, "cmfReceiptID": { "type": "string" }, "cmfRfqID": { "type": "string" }, "cmfRmaClaimID": { "type": "string" }, "cmfRowVersion": { "type": "integer", "format": "int64" }, "cmfSalesOrderID": { "type": "string" }, "cmfShipmentID": { "type": "string" }, "cmfShortDescription": { "type": "string" }, "cmfStartDate": { "type": "string", "format": "date-time" }, "cmfStatus": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPFollowupDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFollowupDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPIndustryTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPIndustryTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPIndustryTypeDto": { "required": [ "cmiIndustryTypeID", "cmiShortDescription" ], "type": "object", "properties": { "cmiIndustryTypeID": { "type": "string" }, "cmiCreatedBy": { "type": "string" }, "cmiCreatedDate": { "type": "string", "format": "date-time" }, "cmiUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmiLongDescriptionRtf": { "type": "string" }, "cmiLongDescriptionText": { "type": "string" }, "cmiRowVersion": { "type": "integer", "format": "int64" }, "cmiShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPIndustryTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPIndustryTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPKnowledgeBasePageDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPKnowledgeBasePageDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPKnowledgeBasePageDto": { "required": [ "kbbKnowledgeBasePageID", "kbbDescription", "kbbOpenedByEmployeeID", "kbbOpenedDate", "kbbPartID", "kbbStatus" ], "type": "object", "properties": { "kbbAccessedCount": { "minimum": 0, "type": "number", "format": "double" }, "kbbClosedByEmployeeID": { "type": "string" }, "kbbClosedDate": { "type": "string", "format": "date-time" }, "kbbKnowledgeBasePageID": { "type": "string" }, "kbbCreatedBy": { "type": "string" }, "kbbCreatedDate": { "type": "string", "format": "date-time" }, "kbbDescription": { "type": "string" }, "kbbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbbOpenedByEmployeeID": { "type": "string" }, "kbbOpenedDate": { "type": "string", "format": "date-time" }, "kbbPartID": { "type": "string" }, "kbbPartRevisionID": { "type": "string" }, "kbbProblemDescriptionRtf": { "type": "string" }, "kbbProblemDescriptionText": { "type": "string" }, "kbbResolutionDescriptionRtf": { "type": "string" }, "kbbResolutionDescriptionText": { "type": "string" }, "kbbResolvedPartID": { "type": "string" }, "kbbResolvedPartRevisionID": { "type": "string" }, "kbbRowVersion": { "type": "integer", "format": "int64" }, "kbbStatus": { "type": "string" }, "kbbWorkAroundDescriptionRtf": { "type": "string" }, "kbbWorkAroundDescriptionText": { "type": "string" } } }, "ERPResponseMessageDto[ERPKnowledgeBasePageDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPKnowledgeBasePageDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLeadCompetitorDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLeadCompetitorDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLeadCompetitorDto": { "required": [ "locLeadID", "locOrganizationID", "locLeadCompetitorID" ], "type": "object", "properties": { "locCreatedBy": { "type": "string" }, "locCreatedDate": { "type": "string", "format": "date-time" }, "locUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "locLeadID": { "type": "string" }, "locLeadNotesRTF": { "type": "string" }, "locLeadNotesText": { "type": "string" }, "locOrganizationID": { "type": "string" }, "locProductName": { "type": "string" }, "locRowVersion": { "type": "integer", "format": "int64" }, "locLeadCompetitorID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPLeadCompetitorDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLeadCompetitorDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLeadLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLeadLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLeadLineDto": { "required": [ "lolDescription", "lolLeadDate", "lolLeadID", "lolPartID", "lolQuantity", "lolLeadLineID" ], "type": "object", "properties": { "lolCreatedBy": { "type": "string" }, "lolCreatedDate": { "type": "string", "format": "date-time" }, "lolCurrencyRateID": { "type": "string" }, "lolDescription": { "type": "string" }, "lolDiscountAmount": { "minimum": 0, "type": "number", "format": "double" }, "lolDiscountAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "lolDiscountPercent": { "minimum": 0, "type": "number", "format": "double" }, "lolUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lolExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "lolForecastDate": { "type": "string", "format": "date-time" }, "lolGrossAmount": { "minimum": 0, "type": "number", "format": "double" }, "lolGrossAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "lolCreatedFromMobile": { "type": "boolean" }, "lolCustomRate": { "type": "boolean" }, "lolTransferredToQuote": { "type": "boolean" }, "lolLeadDate": { "type": "string", "format": "date-time" }, "lolLeadID": { "type": "string" }, "lolOrgPartID": { "type": "string" }, "lolOrgPartShortDescription": { "type": "string" }, "lolPartGroupID": { "type": "string" }, "lolPartID": { "type": "string" }, "lolPartPriceID": { "type": "integer", "format": "int32" }, "lolPartRevisionID": { "type": "string" }, "lolQuantity": { "minimum": 0, "type": "number", "format": "double" }, "lolResolutionReasonID": { "type": "string" }, "lolRevenueForecast": { "minimum": 0, "type": "number", "format": "double" }, "lolRevenueForecastForeign": { "minimum": 0, "type": "number", "format": "double" }, "lolRowVersion": { "type": "integer", "format": "int64" }, "lolLeadLineID": { "type": "integer", "format": "int32" }, "lolUnitOfMeasure": { "type": "string" }, "lolUnitSalePriceBase": { "minimum": 0, "type": "number", "format": "double" }, "lolUnitSalePriceForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPLeadLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLeadLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLeadMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLeadMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLeadMemoDto": { "required": [ "lokLeadID", "lokMemoDate", "lokLeadMemoID", "lokShortDescription" ], "type": "object", "properties": { "lokCreatedBy": { "type": "string" }, "lokCreatedDate": { "type": "string", "format": "date-time" }, "lokUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lokLeadID": { "type": "string" }, "lokLongDescriptionRtf": { "type": "string" }, "lokLongDescriptionText": { "type": "string" }, "lokMemoDate": { "type": "string", "format": "date-time" }, "lokRowVersion": { "type": "integer", "format": "int64" }, "lokLeadMemoID": { "type": "integer", "format": "int32" }, "lokShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPLeadMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLeadMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLeadDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLeadDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLeadDto": { "required": [ "lopLeadID", "lopCustomerOrganizationID", "lopLeadDate", "lopMilestoneDate", "lopMilestoneID", "lopQuoterEmployeeID", "lopResponseMethodID", "lopShipOrganizationID", "lopShortDescription", "lopStatus" ], "type": "object", "properties": { "lopClosedByEmployeeID": { "type": "string" }, "lopClosedDate": { "type": "string", "format": "date-time" }, "lopClosedReasonID": { "type": "string" }, "lopLeadID": { "type": "string" }, "lopContactID": { "type": "string" }, "lopCreatedBy": { "type": "string" }, "lopCreatedDate": { "type": "string", "format": "date-time" }, "lopCurrencyRateID": { "type": "string" }, "lopCustomerOrganizationID": { "type": "string" }, "lopUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lopExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "lopExpectedCloseDate": { "type": "string", "format": "date-time" }, "lopExpirationDate": { "type": "string", "format": "date-time" }, "lopCreatedFromMobile": { "type": "boolean" }, "lopCustomRate": { "type": "boolean" }, "lopLeadDate": { "type": "string", "format": "date-time" }, "lopLeadTotal": { "minimum": 0, "type": "number", "format": "double" }, "lopLeadTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "lopLocationID": { "type": "string" }, "lopLongDescriptionRtf": { "type": "string" }, "lopLongDescriptionText": { "type": "string" }, "lopMarketingProgramID": { "type": "string" }, "lopMilestoneDate": { "type": "string", "format": "date-time" }, "lopMilestoneID": { "type": "string" }, "lopPlantDepartmentID": { "type": "string" }, "lopPlantID": { "type": "string" }, "lopProjectAreaID": { "type": "string" }, "lopProjectID": { "type": "string" }, "lopQuoteContactID": { "type": "string" }, "lopQuoteLocationID": { "type": "string" }, "lopQuoterEmployeeID": { "type": "string" }, "lopReferredBy": { "type": "string" }, "lopResponseMethodID": { "type": "string" }, "lopRowVersion": { "type": "integer", "format": "int64" }, "lopShipContactID": { "type": "string" }, "lopShipLocationID": { "type": "string" }, "lopShipOrganizationID": { "type": "string" }, "lopShortDescription": { "type": "string" }, "lopSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "lopStatus": { "type": "string" } } }, "ERPResponseMessageDto[ERPLeadDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLeadDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLeadSalesPersonDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLeadSalesPersonDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLeadSalesPersonDto": { "required": [ "lojLeadID", "lojSalesEmployeeID", "lojSequenceID" ], "type": "object", "properties": { "lojCreatedBy": { "type": "string" }, "lojCreatedDate": { "type": "string", "format": "date-time" }, "lojUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lojLeadID": { "type": "string" }, "lojPercent": { "minimum": 0, "type": "number", "format": "double" }, "lojRowVersion": { "type": "integer", "format": "int64" }, "lojSalesEmployeeID": { "type": "string" }, "lojSequenceID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPLeadSalesPersonDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLeadSalesPersonDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMarketingProgramDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMarketingProgramDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMarketingProgramDto": { "required": [ "looMarketingProgramID", "looShortDescription" ], "type": "object", "properties": { "looActivityType": { "type": "string" }, "looMarketingProgramID": { "type": "string" }, "looCreatedBy": { "type": "string" }, "looCreatedDate": { "type": "string", "format": "date-time" }, "looEndDate": { "type": "string", "format": "date-time" }, "looUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "looExpectedRevenue": { "minimum": 0, "type": "number", "format": "double" }, "looInactiveDate": { "type": "string", "format": "date-time" }, "looInactive": { "type": "boolean" }, "looLongDescriptionRtf": { "type": "string" }, "looLongDescriptionText": { "type": "string" }, "looMarketingCost": { "minimum": 0, "type": "number", "format": "double" }, "looRowVersion": { "type": "integer", "format": "int64" }, "looShortDescription": { "type": "string" }, "looStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPMarketingProgramDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMarketingProgramDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMilestoneDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMilestoneDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMilestoneDto": { "required": [ "losMilestoneID", "losShortDescription" ], "type": "object", "properties": { "losMilestoneID": { "type": "string" }, "losConfidenceFactor": { "minimum": 0, "type": "number", "format": "double" }, "losCreatedBy": { "type": "string" }, "losCreatedDate": { "type": "string", "format": "date-time" }, "losUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "losLongDescriptionRtf": { "type": "string" }, "losLongDescriptionText": { "type": "string" }, "losRowVersion": { "type": "integer", "format": "int64" }, "losShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPMilestoneDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMilestoneDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationContactGroupLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationContactGroupLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationContactGroupLinkDto": { "required": [ "cmrContactGroupID", "cmrContactID", "cmrOrganizationID" ], "type": "object", "properties": { "cmrContactGroupID": { "type": "string" }, "cmrContactGroupLinkID": { "type": "integer", "format": "int32" }, "cmrContactID": { "type": "string" }, "cmrCreatedBy": { "type": "string" }, "cmrCreatedDate": { "type": "string", "format": "date-time" }, "cmrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmrLocationID": { "type": "string" }, "cmrOrganizationID": { "type": "string" }, "cmrRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPOrganizationContactGroupLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationContactGroupLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationContactDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationContactDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationContactDto": { "required": [ "cmcContactID", "cmcName", "cmcOrganizationID" ], "type": "object", "properties": { "cmcAlternatePhoneNumber": { "type": "string" }, "cmcContactID": { "type": "string" }, "cmcContactTitleID": { "type": "string" }, "cmcCorrespondenceMethod": { "type": "string" }, "cmcCreatedBy": { "type": "string" }, "cmcCreatedDate": { "type": "string", "format": "date-time" }, "cmcEmailAddress": { "type": "string" }, "cmcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmcFaxNumber": { "type": "string" }, "cmcInactiveDate": { "type": "string", "format": "date-time" }, "cmcInactive": { "type": "boolean" }, "cmcCreatedFromMobile": { "type": "boolean" }, "cmcNoMailings": { "type": "boolean" }, "cmcLocationID": { "type": "string" }, "cmcMobileNumber": { "type": "string" }, "cmcName": { "type": "string" }, "cmcNoteRtf": { "type": "string" }, "cmcNoteText": { "type": "string" }, "cmcOrganizationID": { "type": "string" }, "cmcPhoneNumber": { "type": "string" }, "cmcRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPOrganizationContactDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationContactDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationIndustryTypeLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationIndustryTypeLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationIndustryTypeLinkDto": { "required": [ "cmdIndustryTypeID", "cmdOrganizationID" ], "type": "object", "properties": { "cmdCreatedBy": { "type": "string" }, "cmdCreatedDate": { "type": "string", "format": "date-time" }, "cmdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmdIndustryTypeID": { "type": "string" }, "cmdIndustryTypeLinkID": { "type": "integer", "format": "int32" }, "cmdOrganizationID": { "type": "string" }, "cmdRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPOrganizationIndustryTypeLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationIndustryTypeLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationLocationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationLocationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationLocationDto": { "required": [ "cmlName", "cmlOrganizationID" ], "type": "object", "properties": { "cmlAddressLine1": { "type": "string" }, "cmlAddressLine2": { "type": "string" }, "cmlAddressLine3": { "type": "string" }, "cmlAddressValidationResult": { "type": "string" }, "cmlAlternatePhoneNumber": { "type": "string" }, "cmlApInvoiceContactID": { "type": "string" }, "cmlArInvoiceContactID": { "type": "string" }, "cmlAvalaraUseCodes": { "type": "string" }, "cmlBankAccountName": { "type": "string" }, "cmlBankAccountNumber": { "type": "string" }, "cmlBankAccountType": { "type": "string" }, "cmlBankInitials": { "type": "string" }, "cmlBic": { "type": "string" }, "cmlBsbNumber": { "type": "string" }, "cmlCity": { "type": "string" }, "cmlCountry": { "type": "string" }, "cmlCountryCode": { "type": "string" }, "cmlCounty": { "type": "string" }, "cmlCreatedBy": { "type": "string" }, "cmlCreatedDate": { "type": "string", "format": "date-time" }, "cmlCurrencyRateID": { "type": "string" }, "cmlCustomerCreditLimit": { "minimum": 0, "type": "number", "format": "double" }, "cmlCustomerPaymentTermID": { "type": "string" }, "cmlCustomerSecondTaxCodeID": { "type": "string" }, "cmlCustomerShipPaymentTypeID": { "type": "string" }, "cmlCustomerShippingCarrier": { "type": "string" }, "cmlCustomerShippingMethodID": { "type": "string" }, "cmlCustomerTaxCodeID": { "type": "string" }, "cmlEdiLocationID": { "type": "string" }, "cmlEftCode": { "type": "string" }, "cmlEftDescription": { "type": "string" }, "cmlEftParticulars": { "type": "string" }, "cmlEmailAddress": { "type": "string" }, "cmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmlFaxNumber": { "type": "string" }, "cmlFedEx3rdPartyLocationID": { "type": "string" }, "cmlFedEx3rdPartyOrganizationID": { "type": "string" }, "cmlFedExAccountNumber": { "type": "string" }, "cmlFedExBillingOption": { "type": "string" }, "cmlFinanceOrganizationID": { "type": "string" }, "cmlFirstGivenName": { "type": "string" }, "cmlFreeOnBoardDescription": { "type": "string" }, "cmlHdAttachmentFilePath": { "type": "string" }, "cmlIban": { "type": "string" }, "cmlInactiveDate": { "type": "string", "format": "date-time" }, "cmlInactive": { "type": "boolean" }, "cmlApInvoiceLocation": { "type": "boolean" }, "cmlArInvoiceLocation": { "type": "boolean" }, "cmlArInvoicePerShipmentLine": { "type": "boolean" }, "cmlAvalaraAddressValidated": { "type": "boolean" }, "cmlBareCostOfDuty": { "type": "boolean" }, "cmlBareTransportationCost": { "type": "boolean" }, "cmlContractor": { "type": "boolean" }, "cmlCreatedFromMobile": { "type": "boolean" }, "cmlCreditCheckForLocation": { "type": "boolean" }, "cmlCreditHold": { "type": "boolean" }, "cmlCustomerTaxable": { "type": "boolean" }, "cmlDirectPayment": { "type": "boolean" }, "cmlEdiIntegrated": { "type": "boolean" }, "cmlIgnoreAvalara": { "type": "boolean" }, "cmlPurchaseLocation": { "type": "boolean" }, "cmlQuoteLocation": { "type": "boolean" }, "cmlResidentialAddress": { "type": "boolean" }, "cmlShipLocation": { "type": "boolean" }, "cmlTaxReportable": { "type": "boolean" }, "cmlUpsValidated": { "type": "boolean" }, "cmlLastName": { "type": "string" }, "cmlLocationID": { "type": "string" }, "cmlName": { "type": "string" }, "cmlNonTaxReasonID": { "type": "string" }, "cmlOrganizationID": { "type": "string" }, "cmlPhoneNumber": { "type": "string" }, "cmlPostCode": { "type": "string" }, "cmlPurchaseContactID": { "type": "string" }, "cmlQuoteContactID": { "type": "string" }, "cmlRowVersion": { "type": "integer", "format": "int64" }, "cmlSecondGivenName": { "type": "string" }, "cmlShipContactID": { "type": "string" }, "cmlSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "cmlState": { "type": "string" }, "cmlSupplierPaymentTermID": { "type": "string" }, "cmlSupplierShippingMethodID": { "type": "string" }, "cmlTaxExemptNumber": { "type": "string" }, "cmlTradingName": { "type": "string" }, "cmlUps3rdPartyLocationID": { "type": "string" }, "cmlUps3rdPartyOrganizationID": { "type": "string" }, "cmlUpsAcctNumber": { "type": "string" }, "cmlUpsBillingOption": { "type": "string" }, "cmlUpsWsBillingOption": { "type": "string" } } }, "ERPResponseMessageDto[ERPOrganizationLocationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationLocationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationLocSalesPersonDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationLocSalesPersonDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationLocSalesPersonDto": { "required": [ "cmkOrganizationID", "cmkSalesEmployeeID", "cmkSequenceID" ], "type": "object", "properties": { "cmkCreatedBy": { "type": "string" }, "cmkCreatedDate": { "type": "string", "format": "date-time" }, "cmkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmkLocationID": { "type": "string" }, "cmkOrganizationID": { "type": "string" }, "cmkPercent": { "minimum": 0, "type": "number", "format": "double" }, "cmkRowVersion": { "type": "integer", "format": "int64" }, "cmkSalesEmployeeID": { "type": "string" }, "cmkSequenceID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPOrganizationLocSalesPersonDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationLocSalesPersonDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationMemoDto": { "required": [ "cmmMemoDate", "cmmOrganizationID", "cmmOrganizationMemoID", "cmmShortDescription" ], "type": "object", "properties": { "cmmContactID": { "type": "string" }, "cmmCreatedBy": { "type": "string" }, "cmmCreatedDate": { "type": "string", "format": "date-time" }, "cmmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmmLocationID": { "type": "string" }, "cmmLongDescriptionRtf": { "type": "string" }, "cmmLongDescriptionText": { "type": "string" }, "cmmMemoDate": { "type": "string", "format": "date-time" }, "cmmOrganizationID": { "type": "string" }, "cmmRowVersion": { "type": "integer", "format": "int64" }, "cmmOrganizationMemoID": { "type": "integer", "format": "int32" }, "cmmShortDescription": { "type": "string" }, "cmmShowInApInvoices": { "type": "boolean" }, "cmmShowInApPayments": { "type": "boolean" }, "cmmShowInArInvoices": { "type": "boolean" }, "cmmShowInArPayments": { "type": "boolean" }, "cmmShowInCalls": { "type": "boolean" }, "cmmShowInDmrClaims": { "type": "boolean" }, "cmmShowInDmrShipments": { "type": "boolean" }, "cmmShowInLeads": { "type": "boolean" }, "cmmShowInOrganizations": { "type": "boolean" }, "cmmShowInPriceAndAvailability": { "type": "boolean" }, "cmmShowInPurchaseOrders": { "type": "boolean" }, "cmmShowInQuotes": { "type": "boolean" }, "cmmShowInReceipts": { "type": "boolean" }, "cmmShowInRfqs": { "type": "boolean" }, "cmmShowInRmaClaims": { "type": "boolean" }, "cmmShowInRmaReceipts": { "type": "boolean" }, "cmmShowInSalesOrders": { "type": "boolean" }, "cmmShowInShipments": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPOrganizationMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPOrganizationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPOrganizationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPOrganizationDto": { "required": [ "cmoOrganizationID", "cmoName" ], "type": "object", "properties": { "cmoAccountManagerEmployeeID": { "type": "string" }, "cmoAddressLine1": { "type": "string" }, "cmoAddressLine2": { "type": "string" }, "cmoAddressLine3": { "type": "string" }, "cmoAddressValidationResult": { "type": "string" }, "cmoAlternatePhoneNumber": { "type": "string" }, "cmoApInvoiceContactID": { "type": "string" }, "cmoArInvoiceContactID": { "type": "string" }, "cmoAttachmentFileFolder": { "type": "string" }, "cmoAvalaraUseCodes": { "type": "string" }, "cmoBankAccountName": { "type": "string" }, "cmoBankAccountNumber": { "type": "string" }, "cmoBankAccountType": { "type": "string" }, "cmoBankInitials": { "type": "string" }, "cmoBic": { "type": "string" }, "cmoBsbNumber": { "type": "string" }, "cmoCity": { "type": "string" }, "cmoOrganizationID": { "type": "string" }, "cmoCompanyEntryDescription": { "type": "string" }, "cmoCountry": { "type": "string" }, "cmoCountryCode": { "type": "string" }, "cmoCounty": { "type": "string" }, "cmoCreatedBy": { "type": "string" }, "cmoCreatedDate": { "type": "string", "format": "date-time" }, "cmoCurrencyRateID": { "type": "string" }, "cmoCustomerActiveDate": { "type": "string", "format": "date-time" }, "cmoCustomerCreditLimit": { "minimum": 0, "type": "number", "format": "double" }, "cmoCustomerGroupID": { "type": "string" }, "cmoCustomerInactiveDate": { "type": "string", "format": "date-time" }, "cmoCustomerPaymentTermsID": { "type": "string" }, "cmoCustomerProspectDate": { "type": "string", "format": "date-time" }, "cmoCustomerSecondTaxCodeID": { "type": "string" }, "cmoCustomerShipPaymentTypeID": { "type": "string" }, "cmoCustomerShippingCarrier": { "type": "string" }, "cmoCustomerShippingMethodID": { "type": "string" }, "cmoCustomerStatus": { "type": "integer", "format": "int32" }, "cmoCustomerTaxCodeID": { "type": "string" }, "cmoDefaultApInvoiceLocationID": { "type": "string" }, "cmoDefaultArInvoiceLocationID": { "type": "string" }, "cmoDefaultPurchaseLocationID": { "type": "string" }, "cmoDefaultQuoteLocationID": { "type": "string" }, "cmoDefaultShipLocationID": { "type": "string" }, "cmoDropShipLocationID": { "type": "string" }, "cmoDropShipOrganizationID": { "type": "string" }, "cmoEftCode": { "type": "string" }, "cmoEftDescription": { "type": "string" }, "cmoEftParticulars": { "type": "string" }, "cmoEmailAddress": { "type": "string" }, "cmoEmployeeCount": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "cmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmoEstablishedDate": { "type": "string", "format": "date-time" }, "cmoExpenseSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "cmoFaxNumber": { "type": "string" }, "cmoFederalID": { "type": "string" }, "cmoFedEx3rdPartyLocationID": { "type": "string" }, "cmoFedEx3rdPartyOrganizationID": { "type": "string" }, "cmoFedExAccountNumber": { "type": "string" }, "cmoFedExBillingOption": { "type": "string" }, "cmoFirstGivenName": { "type": "string" }, "cmoForm1099Box": { "type": "integer", "format": "int32" }, "cmoFreeOnBoardDescription": { "type": "string" }, "cmoHdAttachmentFilePath": { "type": "string" }, "cmoIban": { "type": "string" }, "cmoIntraCompanyDatasetID": { "type": "string" }, "cmoApIncludeTaxInRetention": { "type": "boolean" }, "cmoArIncludeTaxInRetention": { "type": "boolean" }, "cmoArInvoicePerShipmentLine": { "type": "boolean" }, "cmoAvalaraAddressValidated": { "type": "boolean" }, "cmoBareCostOfDuty": { "type": "boolean" }, "cmoBareTransportationCost": { "type": "boolean" }, "cmoCalculateFinanceCharges": { "type": "boolean" }, "cmoCompetitor": { "type": "boolean" }, "cmoContractor": { "type": "boolean" }, "cmoCreatedFromMobile": { "type": "boolean" }, "cmoCreditHold": { "type": "boolean" }, "cmoCustomerTaxable": { "type": "boolean" }, "cmoDirectPayment": { "type": "boolean" }, "cmoEdiIntegrated": { "type": "boolean" }, "cmoFinanceCompany": { "type": "boolean" }, "cmoIgnoreAvalara": { "type": "boolean" }, "cmoIncludeFreightInPrice": { "type": "boolean" }, "cmoPrintStatement": { "type": "boolean" }, "cmoRequires1099": { "type": "boolean" }, "cmoRequiresInspection": { "type": "boolean" }, "cmoResidentialAddress": { "type": "boolean" }, "cmoSuperFund": { "type": "boolean" }, "cmoSupplierAccredited": { "type": "boolean" }, "cmoSupplierTaxable": { "type": "boolean" }, "cmoTaxReportable": { "type": "boolean" }, "cmoUpsValidated": { "type": "boolean" }, "cmoJobPriorityID": { "type": "integer", "format": "int32" }, "cmoLastName": { "type": "string" }, "cmoLongDescriptionRtf": { "type": "string" }, "cmoLongDescriptionText": { "type": "string" }, "cmoName": { "type": "string" }, "cmoNonTaxReasonID": { "type": "string" }, "cmoOrganizationAccountID": { "type": "string" }, "cmoPhoneNumber": { "type": "string" }, "cmoPostCode": { "type": "string" }, "cmoPurchaseContactID": { "type": "string" }, "cmoQuoteContactID": { "type": "string" }, "cmoResellerActiveDate": { "type": "string", "format": "date-time" }, "cmoResellerCommissionRate": { "minimum": 0, "type": "number", "format": "double" }, "cmoResellerContactID": { "type": "string" }, "cmoResellerInactiveDate": { "type": "string", "format": "date-time" }, "cmoResellerLocationID": { "type": "string" }, "cmoResellerOrganizationID": { "type": "string" }, "cmoResellerProspectDate": { "type": "string", "format": "date-time" }, "cmoResellerStatus": { "type": "integer", "format": "int32" }, "cmoRowVersion": { "type": "integer", "format": "int64" }, "cmoSecondGivenName": { "type": "string" }, "cmoShipContactID": { "type": "string" }, "cmoSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "cmoState": { "type": "string" }, "cmoSuperFundEmployerID": { "type": "string" }, "cmoSuperFundName": { "type": "string" }, "cmoSupplierAccreditedDate": { "type": "string", "format": "date-time" }, "cmoSupplierActiveDate": { "type": "string", "format": "date-time" }, "cmoSupplierInactiveDate": { "type": "string", "format": "date-time" }, "cmoSupplierPaymentTermID": { "type": "string" }, "cmoSupplierProspectDate": { "type": "string", "format": "date-time" }, "cmoSupplierRatingID": { "type": "string" }, "cmoSupplierSecondTaxCodeID": { "type": "string" }, "cmoSupplierShippingMethodID": { "type": "string" }, "cmoSupplierStatus": { "type": "integer", "format": "int32" }, "cmoSupplierTaxCodeID": { "type": "string" }, "cmoTaxExemptNumber": { "type": "string" }, "cmoTradingName": { "type": "string" }, "cmoUps3rdPartyLocationID": { "type": "string" }, "cmoUps3rdPartyOrganizationID": { "type": "string" }, "cmoUpsAcctNumber": { "type": "string" }, "cmoUpsBillingOption": { "type": "string" }, "cmoUpsWsBillingOption": { "type": "string" }, "cmoUsaTransactionTypeCode": { "type": "string" }, "cmoWebAddress": { "type": "string" } } }, "ERPResponseMessageDto[ERPOrganizationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPOrganizationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPServiceContractLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPServiceContractLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPServiceContractLineDto": { "required": [ "kbnPartID", "kbnPartShortDescription", "kbnServiceContractLineID", "kbnServiceContractID" ], "type": "object", "properties": { "kbnContractLength": { "type": "integer", "format": "int32" }, "kbnContractLengthType": { "type": "string" }, "kbnCreatedBy": { "type": "string" }, "kbnCreatedDate": { "type": "string", "format": "date-time" }, "kbnEndDate": { "type": "string", "format": "date-time" }, "kbnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbnPartID": { "type": "string" }, "kbnPartRevisionID": { "type": "string" }, "kbnPartShortDescription": { "type": "string" }, "kbnRowVersion": { "type": "integer", "format": "int64" }, "kbnServiceContractLineID": { "type": "integer", "format": "int32" }, "kbnSerialNumberID": { "type": "string" }, "kbnServiceContractID": { "type": "string" }, "kbnStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPServiceContractLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPServiceContractLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPServiceContractMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPServiceContractMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPServiceContractMemoDto": { "required": [ "kbmMemoDate", "kbmServiceContractMemoID", "kbmServiceContractID", "kbmShortDescription" ], "type": "object", "properties": { "kbmCreatedBy": { "type": "string" }, "kbmCreatedDate": { "type": "string", "format": "date-time" }, "kbmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbmLongDescriptionRtf": { "type": "string" }, "kbmLongDescriptionText": { "type": "string" }, "kbmMemoDate": { "type": "string", "format": "date-time" }, "kbmRowVersion": { "type": "integer", "format": "int64" }, "kbmServiceContractMemoID": { "type": "integer", "format": "int32" }, "kbmServiceContractID": { "type": "string" }, "kbmShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPServiceContractMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPServiceContractMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPServiceContractOwnerDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPServiceContractOwnerDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPServiceContractOwnerDto": { "required": [ "kboServiceContractOwnerID", "kboServiceContractID" ], "type": "object", "properties": { "kboAddressLine1": { "type": "string" }, "kboAddressLine2": { "type": "string" }, "kboAddressLine3": { "type": "string" }, "kboCity": { "type": "string" }, "kboCountry": { "type": "string" }, "kboCreatedBy": { "type": "string" }, "kboCreatedDate": { "type": "string", "format": "date-time" }, "kboDeliveryDate": { "type": "string", "format": "date-time" }, "kboEmailAddress": { "type": "string" }, "kboUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kboFaxNumber": { "type": "string" }, "kboFirstName": { "type": "string" }, "kboHomePhoneNumber": { "type": "string" }, "kboCurrentOwner": { "type": "boolean" }, "kboSameAsAbove": { "type": "boolean" }, "kboTermsAccepted": { "type": "boolean" }, "kboLastName": { "type": "string" }, "kboMiddleName": { "type": "string" }, "kboMobileNumber": { "type": "string" }, "kboOrganizationID": { "type": "string" }, "kboPhysicalAddressLine1": { "type": "string" }, "kboPhysicalAddressLine2": { "type": "string" }, "kboPhysicalAddressLine3": { "type": "string" }, "kboPhysicalCity": { "type": "string" }, "kboPhysicalCountry": { "type": "string" }, "kboPhysicalLocationCity": { "type": "string" }, "kboPhysicalLocationState": { "type": "string" }, "kboPhysicalPostCode": { "type": "string" }, "kboPhysicalState": { "type": "string" }, "kboPostCode": { "type": "string" }, "kboRegisteredDate": { "type": "string", "format": "date-time" }, "kboRowVersion": { "type": "integer", "format": "int64" }, "kboServiceContractOwnerID": { "type": "integer", "format": "int32" }, "kboServiceContractID": { "type": "string" }, "kboStartDate": { "type": "string", "format": "date-time" }, "kboState": { "type": "string" }, "kboWorkPhoneNumber": { "type": "string" } } }, "ERPResponseMessageDto[ERPServiceContractOwnerDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPServiceContractOwnerDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPServiceContractDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPServiceContractDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPServiceContractDto": { "required": [ "kbsServiceContractID", "kbsDescription", "kbsEndDate", "kbsOrganizationID", "kbsStartDate" ], "type": "object", "properties": { "kbsServiceContractID": { "type": "string" }, "kbsContractAmount": { "minimum": 0, "type": "number", "format": "double" }, "kbsContractLength": { "type": "integer", "format": "int32" }, "kbsContractLengthType": { "type": "string" }, "kbsCreatedBy": { "type": "string" }, "kbsCreatedDate": { "type": "string", "format": "date-time" }, "kbsDescription": { "type": "string" }, "kbsEndDate": { "type": "string", "format": "date-time" }, "kbsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbsLongDescriptionRtf": { "type": "string" }, "kbsLongDescriptionText": { "type": "string" }, "kbsOrganizationID": { "type": "string" }, "kbsPartID": { "type": "string" }, "kbsPartRevisionID": { "type": "string" }, "kbsPartShortDescription": { "type": "string" }, "kbsProjectAreaID": { "type": "string" }, "kbsProjectID": { "type": "string" }, "kbsResellerOrganizationID": { "type": "string" }, "kbsRowVersion": { "type": "integer", "format": "int64" }, "kbsSerialNumberID": { "type": "string" }, "kbsServiceContractTypeID": { "type": "string" }, "kbsStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPServiceContractDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPServiceContractDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPServiceContractTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPServiceContractTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPServiceContractTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPServiceContractTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSupplierRatingDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSupplierRatingDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSupplierRatingDto": { "required": [ "cmsSupplierRatingID", "cmsDescription" ], "type": "object", "properties": { "cmsSupplierRatingID": { "type": "string" }, "cmsCreatedBy": { "type": "string" }, "cmsCreatedDate": { "type": "string", "format": "date-time" }, "cmsDescription": { "type": "string" }, "cmsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmsRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPSupplierRatingDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSupplierRatingDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCustomTableDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCustomTableDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCustomTableDto": { "type": "object" }, "ERPResponseMessageDto[ERPCustomTableDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCustomTableDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPExpenseDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPExpenseDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPExpenseDto": { "required": [ "lmxExpenseID", "lmxDescription" ], "type": "object", "properties": { "lmxExpenseID": { "type": "string" }, "lmxCreatedBy": { "type": "string" }, "lmxCreatedDate": { "type": "string", "format": "date-time" }, "lmxDescription": { "type": "string" }, "lmxUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmxRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPExpenseDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPExpenseDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPIndirectLaborCodeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPIndirectLaborCodeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPIndirectLaborCodeDto": { "required": [ "lmiDescription", "lmiIndirectLaborID" ], "type": "object", "properties": { "lmiCreatedBy": { "type": "string" }, "lmiCreatedDate": { "type": "string", "format": "date-time" }, "lmiDescription": { "type": "string" }, "lmiUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmiInactiveDate": { "type": "string", "format": "date-time" }, "lmiIndirectLaborID": { "type": "string" }, "lmiIndirectLaborType": { "type": "integer", "format": "int32" }, "lmiInactive": { "type": "boolean" }, "lmiRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPIndirectLaborCodeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPIndirectLaborCodeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPTimecardLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPTimecardLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPTimecardLineDto": { "required": [ "lmlEmployeeID", "lmlExpenseID", "lmlTimecardLineID", "lmlSource", "lmlTimecardID", "lmlTimecardType", "lmlWorkCenterID" ], "type": "object", "properties": { "lmlActualEndTime": { "type": "string", "format": "date-time" }, "lmlActualStartTime": { "type": "string", "format": "date-time" }, "lmlCompletionType": { "type": "integer", "format": "int32" }, "lmlCreatedBy": { "type": "string" }, "lmlCreatedDate": { "type": "string", "format": "date-time" }, "lmlEmployeeID": { "type": "string" }, "lmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmlExpenseID": { "type": "string" }, "lmlGoodQuantity": { "minimum": 0, "type": "number", "format": "double" }, "lmlIndirectLaborID": { "type": "string" }, "lmlActive": { "type": "boolean" }, "lmlCreatedFromPayrollSession": { "type": "boolean" }, "lmlLaborHoursCalculated": { "type": "boolean" }, "lmlMachineHoursCalculated": { "type": "boolean" }, "lmlPostedToWip": { "type": "boolean" }, "lmlSuspended": { "type": "boolean" }, "lmlTransferredToPayroll": { "type": "boolean" }, "lmlJobAssemblyID": { "type": "integer", "format": "int32" }, "lmlJobID": { "type": "string" }, "lmlJobOperationID": { "type": "integer", "format": "int32" }, "lmlLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "lmlLaborDescriptionRtf": { "type": "string" }, "lmlLaborDescriptionText": { "type": "string" }, "lmlLaborHours": { "minimum": 0, "type": "number", "format": "double" }, "lmlMachineHours": { "minimum": 0, "type": "number", "format": "double" }, "lmlOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "lmlProcessID": { "type": "string" }, "lmlProjectAreaID": { "type": "string" }, "lmlProjectID": { "type": "string" }, "lmlReworkQuantity": { "minimum": 0, "type": "number", "format": "double" }, "lmlReworkReasonID": { "type": "string" }, "lmlRoundedEndTime": { "type": "string", "format": "date-time" }, "lmlRoundedStartTime": { "type": "string", "format": "date-time" }, "lmlRowVersion": { "type": "integer", "format": "int64" }, "lmlScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "lmlScrapReasonID": { "type": "string" }, "lmlTimecardLineID": { "type": "integer", "format": "int32" }, "lmlSetupPercentCompleted": { "type": "integer", "format": "int32" }, "lmlShiftID": { "type": "integer", "format": "int32" }, "lmlSource": { "type": "integer", "format": "int32" }, "lmlTimecardID": { "type": "integer", "format": "int32" }, "lmlTimecardType": { "type": "integer", "format": "int32" }, "lmlWorkCenterID": { "type": "string" }, "lmlWorkType": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPTimecardLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPTimecardLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPTimecardDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPTimecardDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPTimecardDto": { "required": [ "lmpEmployeeID", "lmpTimecardID", "lmpShiftID", "lmpSource", "lmpTimecardDate" ], "type": "object", "properties": { "lmpActualEndTime": { "type": "string", "format": "date-time" }, "lmpActualStartTime": { "type": "string", "format": "date-time" }, "lmpCreatedBy": { "type": "string" }, "lmpCreatedDate": { "type": "string", "format": "date-time" }, "lmpEmployeeID": { "type": "string" }, "lmpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmpExchangeID": { "type": "string" }, "lmpActive": { "type": "boolean" }, "lmpAutoClockedOut": { "type": "boolean" }, "lmpCreatedFromPayrollSession": { "type": "boolean" }, "lmpPostedToWip": { "type": "boolean" }, "lmpTransferredToPayroll": { "type": "boolean" }, "lmpLastEndTime": { "type": "string", "format": "date-time" }, "lmpLeaveAccrualID": { "type": "string" }, "lmpMachineHours": { "minimum": 0, "type": "number", "format": "double" }, "lmpNoteRtf": { "type": "string" }, "lmpNoteText": { "type": "string" }, "lmpOtherHours": { "minimum": 0, "type": "number", "format": "double" }, "lmpOtherPayrollRateID": { "type": "string" }, "lmpOTPeriod1Hours": { "minimum": 0, "type": "number", "format": "double" }, "lmpOTPeriod1PayrollRateID": { "type": "string" }, "lmpOTPeriod2Hours": { "minimum": 0, "type": "number", "format": "double" }, "lmpOTPeriod2PayrollRateID": { "type": "string" }, "lmpOTPeriod3Hours": { "minimum": 0, "type": "number", "format": "double" }, "lmpOTPeriod3PayrollRateID": { "type": "string" }, "lmpOTPeriod4Hours": { "minimum": 0, "type": "number", "format": "double" }, "lmpOTPeriod4PayrollRateID": { "type": "string" }, "lmpPaidDate": { "type": "string", "format": "date-time" }, "lmpPayrollHours": { "minimum": 0, "type": "number", "format": "double" }, "lmpPlantDepartmentID": { "type": "string" }, "lmpPlantID": { "type": "string" }, "lmpPostedDate": { "type": "string", "format": "date-time" }, "lmpProjectID": { "type": "string" }, "lmpRoundedEndTime": { "type": "string", "format": "date-time" }, "lmpRoundedStartTime": { "type": "string", "format": "date-time" }, "lmpRowVersion": { "type": "integer", "format": "int64" }, "lmpTimecardID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "lmpShiftBreakID": { "type": "integer", "format": "int32" }, "lmpShiftID": { "type": "integer", "format": "int32" }, "lmpSource": { "type": "integer", "format": "int32" }, "lmpStandardHours": { "minimum": 0, "type": "number", "format": "double" }, "lmpStandardPayrollRateID": { "type": "string" }, "lmpTimecardDate": { "type": "string", "format": "date-time" }, "lmpTotalPayrollHours": { "minimum": 0, "type": "number", "format": "double" }, "lmpTransferredDate": { "type": "string", "format": "date-time" }, "lmpUtcOffset": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPTimecardDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPTimecardDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "MesTimecardDto": { "type": "object", "properties": { "employeeId": { "type": "string" }, "timecardDate": { "type": "string", "format": "date-time" }, "shiftID": { "type": "integer", "format": "int32" }, "timecardLines": { "type": "array", "items": { "$ref": "#/components/schemas/MesTimecardLineDto" } } } }, "ERPResponseMessageDto[MesIntegrationTransactionQueueInformationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/MesIntegrationTransactionQueueInformationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAttachmentMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAttachmentMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAttachmentMemoDto": { "required": [ "cmqAttachmentID", "cmqMemoDate", "cmqAttachmentMemoID", "cmqShortDescription" ], "type": "object", "properties": { "cmqAttachmentID": { "type": "string" }, "cmqCreatedBy": { "type": "string" }, "cmqCreatedDate": { "type": "string", "format": "date-time" }, "cmqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmqLongDescriptionRtf": { "type": "string" }, "cmqLongDescriptionText": { "type": "string" }, "cmqMemoDate": { "type": "string", "format": "date-time" }, "cmqRowVersion": { "type": "integer", "format": "int64" }, "cmqAttachmentMemoID": { "type": "integer", "format": "int32" }, "cmqShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPAttachmentMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAttachmentMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAttachmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAttachmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAttachmentDto": { "required": [ "cmaAttachmentID", "cmaDate", "cmaShortDescription" ], "type": "object", "properties": { "cmaApInvoiceID": { "type": "string" }, "cmaArInvoiceID": { "type": "string" }, "cmaAttachmentTypeID": { "type": "string" }, "cmaCallID": { "type": "string" }, "cmaChangeRequestID": { "type": "string" }, "cmaAttachmentID": { "type": "string" }, "cmaContactID": { "type": "string" }, "cmaCreatedBy": { "type": "string" }, "cmaCreatedDate": { "type": "string", "format": "date-time" }, "cmaCustomerGroupID": { "type": "string" }, "cmaDate": { "type": "string", "format": "date-time" }, "cmaDmrClaimID": { "type": "string" }, "cmaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmaFileLocation": { "type": "string" }, "cmaFilename": { "type": "string" }, "cmaInspectionID": { "type": "string" }, "cmaInspectionLineID": { "type": "integer", "format": "int32" }, "cmaDoNotAllowDownload": { "type": "boolean" }, "cmaEmailDefault": { "type": "boolean" }, "cmaPrintDefault": { "type": "boolean" }, "cmaReviewed": { "type": "boolean" }, "cmaJobID": { "type": "string" }, "cmaKnowledgeBasePageID": { "type": "string" }, "cmaLeadID": { "type": "string" }, "cmaLocationID": { "type": "string" }, "cmaLongDescriptionRtf": { "type": "string" }, "cmaLongDescriptionText": { "type": "string" }, "cmaNonConformanceID": { "type": "string" }, "cmaOrganizationID": { "type": "string" }, "cmaPartID": { "type": "string" }, "cmaProjectAreaID": { "type": "string" }, "cmaProjectID": { "type": "string" }, "cmaPurchaseOrderID": { "type": "string" }, "cmaQuoteID": { "type": "string" }, "cmaReceiptID": { "type": "string" }, "cmaRfqID": { "type": "string" }, "cmaRmaClaimID": { "type": "string" }, "cmaRowVersion": { "type": "integer", "format": "int64" }, "cmaSalesOrderID": { "type": "string" }, "cmaShipmentID": { "type": "string" }, "cmaShortDescription": { "type": "string" }, "cmaWorkFlowID": { "type": "string" }, "cmaWorkFlowLineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAttachmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAttachmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAttachmentTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAttachmentTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAttachmentTypeDto": { "required": [ "cmtAttachmentTypeID", "cmtDescription" ], "type": "object", "properties": { "cmtAttachmentTypeID": { "type": "string" }, "cmtCreatedBy": { "type": "string" }, "cmtCreatedDate": { "type": "string", "format": "date-time" }, "cmtDescription": { "type": "string" }, "cmtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cmtRequiresLogin": { "type": "boolean" }, "cmtRequiresServiceContract": { "type": "boolean" }, "cmtRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPAttachmentTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAttachmentTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDocumentLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDocumentLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDocumentLinkDto": { "required": [ "xalAddedByUserID", "xalAddedDate", "xalDescription", "xalFileName", "xalDocumentLinkID" ], "type": "object", "properties": { "xalAddedByUserID": { "type": "string" }, "xalAddedDate": { "type": "string", "format": "date-time" }, "xalCloudFileId": { "type": "string" }, "xalCreatedBy": { "type": "string" }, "xalCreatedDate": { "type": "string", "format": "date-time" }, "xalDescription": { "type": "string" }, "xalUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xalFileLastModifiedDate": { "type": "string", "format": "date-time" }, "xalFileName": { "type": "string" }, "xalFileNameWhenUploaded": { "type": "string" }, "xalEmailDefault": { "type": "boolean" }, "xalPrintDefault": { "type": "boolean" }, "xalReference": { "type": "string" }, "xalRowVersion": { "type": "integer", "format": "int64" }, "xalDocumentLinkID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "xalType": { "type": "string" } } }, "ERPResponseMessageDto[ERPDocumentLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDocumentLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeAttachmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeAttachmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeeAttachmentDto": { "required": [ "lmaEmployeeAttachmentID", "lmaDate", "lmaEmployeeID", "lmaShortDescription" ], "type": "object", "properties": { "lmaAttachmentTypeID": { "type": "string" }, "lmaEmployeeAttachmentID": { "type": "string" }, "lmaCreatedBy": { "type": "string" }, "lmaCreatedDate": { "type": "string", "format": "date-time" }, "lmaDate": { "type": "string", "format": "date-time" }, "lmaEmployeeID": { "type": "string" }, "lmaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmaFileLocation": { "type": "string" }, "lmaFileName": { "type": "string" }, "lmaLongDescriptionRtf": { "type": "string" }, "lmaLongDescriptionText": { "type": "string" }, "lmaRowVersion": { "type": "integer", "format": "int64" }, "lmaShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPEmployeeAttachmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeAttachmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeeMemoDto": { "required": [ "lmkEmployeeID", "lmkMemoDate", "lmkEmployeeMemoID", "lmkShortDescription" ], "type": "object", "properties": { "lmkCreatedBy": { "type": "string" }, "lmkCreatedDate": { "type": "string", "format": "date-time" }, "lmkEmployeeID": { "type": "string" }, "lmkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmkLongDescriptionRtf": { "type": "string" }, "lmkLongDescriptionText": { "type": "string" }, "lmkMemoDate": { "type": "string", "format": "date-time" }, "lmkRowVersion": { "type": "integer", "format": "int64" }, "lmkEmployeeMemoID": { "type": "integer", "format": "int32" }, "lmkShortDescription": { "type": "string" }, "lmkShowInEmployees": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPEmployeeMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeePersonalDatumDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeePersonalDatumDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeePersonalDatumDto": { "required": [ "lmdEmployeeID" ], "type": "object", "properties": { "lmdAddressLine1": { "type": "string" }, "lmdAddressLine2": { "type": "string" }, "lmdAddressLine3": { "type": "string" }, "lmdBasisOfPayment": { "type": "string" }, "lmdBirthDate": { "type": "string", "format": "date-time" }, "lmdCity": { "type": "string" }, "lmdContact1HomePhoneNumber": { "type": "string" }, "lmdContact1MobilePhoneNumber": { "type": "string" }, "lmdContact1Name": { "type": "string" }, "lmdContact1Relationship": { "type": "string" }, "lmdContact1WorkPhoneNumber": { "type": "string" }, "lmdContact2HomePhoneNumber": { "type": "string" }, "lmdContact2MobilePhoneNumber": { "type": "string" }, "lmdContact2Name": { "type": "string" }, "lmdContact2Relationship": { "type": "string" }, "lmdContact2WorkPhoneNumber": { "type": "string" }, "lmdCountry": { "type": "string" }, "lmdCreatedBy": { "type": "string" }, "lmdCreatedDate": { "type": "string", "format": "date-time" }, "lmdEmployeeFirstName": { "type": "string" }, "lmdEmployeeID": { "type": "string" }, "lmdEmployeeLastName": { "type": "string" }, "lmdEmployeeMiddleName": { "type": "string" }, "lmdEmploymentDeclarationDate": { "type": "string", "format": "date-time" }, "lmdEmploymentStatus": { "type": "string" }, "lmdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmdFaxNumber": { "type": "string" }, "lmdGender": { "type": "string" }, "lmdHomeCountry": { "type": "string" }, "lmdEmploymentDeclarationOnFile": { "type": "boolean" }, "lmdPayrollEmployee": { "type": "boolean" }, "lmdStdntFinSupplSchemeLoan": { "type": "boolean" }, "lmdStudyTrainLoanRepayment": { "type": "boolean" }, "lmdTaxFreeThresholdClaimed": { "type": "boolean" }, "lmdWorkingHolidayMaker": { "type": "boolean" }, "lmdLaborRate": { "minimum": 0, "type": "number", "format": "double" }, "lmdMaritalStatus": { "type": "string" }, "lmdMobileNumber": { "type": "string" }, "lmdNZTaxCode": { "type": "string" }, "lmdPAYGSummaryType": { "type": "string" }, "lmdPayrollDefinitionID": { "type": "string" }, "lmdPayrollExportEmployeeID": { "type": "string" }, "lmdPersonalEmailAddress": { "type": "string" }, "lmdPhoneNumber": { "type": "string" }, "lmdPostCode": { "type": "string" }, "lmdResidencyStatus": { "type": "string" }, "lmdRowVersion": { "type": "integer", "format": "int64" }, "lmdState": { "type": "string" }, "lmdStateAus": { "type": "string" }, "lmdTaxFileNumber": { "type": "string" } } }, "ERPResponseMessageDto[ERPEmployeePersonalDatumDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeePersonalDatumDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeePOApprovalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeePOApprovalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeePOApprovalDto": { "required": [ "lmhApprovalEmployeeID", "lmhEmployeeID", "lmhEmployeePoApprovalID" ], "type": "object", "properties": { "lmhApprovalEmployeeID": { "type": "string" }, "lmhCreatedBy": { "type": "string" }, "lmhCreatedDate": { "type": "string", "format": "date-time" }, "lmhEmployeeID": { "type": "string" }, "lmhUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmhRowVersion": { "type": "integer", "format": "int64" }, "lmhEmployeePoApprovalID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeePOApprovalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeePOApprovalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeQAApprovalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeQAApprovalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeeQAApprovalDto": { "required": [ "lmbApprovalEmployeeID", "lmbEmployeeID", "lmbEmployeeQAApprovalID" ], "type": "object", "properties": { "lmbApprovalEmployeeID": { "type": "string" }, "lmbCreatedBy": { "type": "string" }, "lmbCreatedDate": { "type": "string", "format": "date-time" }, "lmbEmployeeID": { "type": "string" }, "lmbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmbRowVersion": { "type": "integer", "format": "int64" }, "lmbEmployeeQAApprovalID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeeQAApprovalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeQAApprovalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeeDto": { "required": [ "lmeEmployeeID", "lmeEmployeeName", "lmeHireDate" ], "type": "object", "properties": { "lmeCallTypeID": { "type": "string" }, "lmeCessationType": { "type": "string" }, "lmeEmployeeID": { "type": "string" }, "lmeCommissionRate": { "minimum": 0, "type": "number", "format": "double" }, "lmeContactTitleID": { "type": "string" }, "lmeCountyCodeID": { "type": "string" }, "lmeCreatedBy": { "type": "string" }, "lmeCreatedDate": { "type": "string", "format": "date-time" }, "lmeDefaultShiftID": { "type": "integer", "format": "int32" }, "lmeDefaultWorkCenterID": { "type": "string" }, "lmeDirectExpenseID": { "type": "string" }, "lmeEarningType": { "type": "integer", "format": "int32" }, "lmeEmployeeName": { "type": "string" }, "lmeUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmeHireDate": { "type": "string", "format": "date-time" }, "lmeHomeProductionDepartmentID": { "type": "string" }, "lmeIndirectExpenseID": { "type": "string" }, "lmeBuyerEmployee": { "type": "boolean" }, "lmeEngineerEmployee": { "type": "boolean" }, "lmeInspectorEmployee": { "type": "boolean" }, "lmeLockShift": { "type": "boolean" }, "lmePayrollEmployee": { "type": "boolean" }, "lmePlannerEmployee": { "type": "boolean" }, "lmeProjectManagerEmployee": { "type": "boolean" }, "lmeQuoterEmployee": { "type": "boolean" }, "lmeSalesEmployee": { "type": "boolean" }, "lmeShopEmployee": { "type": "boolean" }, "lmeSortSfebyWorkcenter": { "type": "boolean" }, "lmeSupportEmployee": { "type": "boolean" }, "lmeLanguage": { "type": "string" }, "lmePassword": { "type": "string" }, "lmePlantDepartmentID": { "type": "string" }, "lmePlantID": { "type": "string" }, "lmePoApprovalAmount": { "minimum": 0, "type": "number", "format": "double" }, "lmePreviousEmployeeID": { "type": "string" }, "lmeRowVersion": { "type": "integer", "format": "int64" }, "lmeSOApprovalAmount": { "minimum": 0, "type": "number", "format": "double" }, "lmeTerminationDate": { "type": "string", "format": "date-time" }, "lmeTerminationReasonID": { "type": "string" }, "lmeUseEmail": { "type": "integer", "format": "int32" }, "lmeUseEmailPayslips": { "type": "integer", "format": "int32" }, "lmeUserID": { "type": "string" }, "lmeWorkEmailAddress": { "type": "string" } } }, "ERPResponseMessageDto[ERPEmployeeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeSalesBudgetLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeeSalesBudgetLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeSalesBudgetLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeSalesBudgetDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeSalesBudgetDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeeSalesBudgetDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeSalesBudgetDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeSkillCompetencyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeSkillCompetencyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeeSkillCompetencyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeSkillCompetencyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeSkillDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeSkillDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeeSkillDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeSkillDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPEmployeeSOApprovalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPEmployeeSOApprovalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPEmployeeSOApprovalDto": { "required": [ "lmoApprovalEmployeeID", "lmoEmployeeID", "lmoEmployeeSOApprovalID" ], "type": "object", "properties": { "lmoApprovalEmployeeID": { "type": "string" }, "lmoCreatedBy": { "type": "string" }, "lmoCreatedDate": { "type": "string", "format": "date-time" }, "lmoEmployeeID": { "type": "string" }, "lmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmoRowVersion": { "type": "integer", "format": "int64" }, "lmoEmployeeSOApprovalID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPEmployeeSOApprovalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPEmployeeSOApprovalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShiftBreakDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShiftBreakDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPShiftBreakDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShiftBreakDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShiftDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShiftDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPShiftDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShiftDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSkillCompetencyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSkillCompetencyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSkillCompetencyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSkillCompetencyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSkillDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSkillDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSkillDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSkillDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWorkCenterSkillCompetencyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWorkCenterSkillCompetencyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPWorkCenterSkillCompetencyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWorkCenterSkillCompetencyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWorkCenterSkillDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWorkCenterSkillDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPWorkCenterSkillDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWorkCenterSkillDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAgingBucketDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAgingBucketDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAgingBucketDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAgingBucketDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPInvoiceExpenseAccountDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPInvoiceExpenseAccountDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPInvoiceExpenseAccountDto": { "required": [ "apxApInvoiceID", "apxApInvoiceLineID", "apxExpenseGlAccountID", "apxApInvoiceExpenseAccountID" ], "type": "object", "properties": { "apxAmount": { "minimum": 0, "type": "number", "format": "double" }, "apxApInvoiceID": { "type": "string" }, "apxApInvoiceLineID": { "type": "integer", "format": "int32" }, "apxCreatedBy": { "type": "string" }, "apxCreatedDate": { "type": "string", "format": "date-time" }, "apxUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "apxExpenseGlAccountID": { "type": "string" }, "apxPostedToGl": { "type": "boolean" }, "apxPercent": { "minimum": 0, "type": "number", "format": "double" }, "apxRowVersion": { "type": "integer", "format": "int64" }, "apxApInvoiceExpenseAccountID": { "type": "integer", "format": "int32" }, "apxSourceTableName": { "type": "string" }, "apxSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" } } }, "ERPResponseMessageDto[ERPAPInvoiceExpenseAccountDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPInvoiceExpenseAccountDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPInvoiceLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPInvoiceLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPInvoiceLineDto": { "required": [ "aplApInvoiceID", "aplPurchaseQuantity", "aplReceivedQuantity" ], "type": "object", "properties": { "aplApInvoiceID": { "type": "string" }, "aplAssetID": { "type": "string" }, "aplAssetTypeID": { "type": "string" }, "aplConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "aplCreatedBy": { "type": "string" }, "aplCreatedDate": { "type": "string", "format": "date-time" }, "aplDmrClaimID": { "type": "string" }, "aplDmrClaimLineID": { "type": "integer", "format": "int32" }, "aplDmrShipmentID": { "type": "string" }, "aplDmrShipmentLineID": { "type": "integer", "format": "int32" }, "aplUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "aplExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "aplExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "aplForm1099Box": { "type": "integer", "format": "int32" }, "aplInvoicedComplete": { "type": "boolean" }, "aplPostedToGl": { "type": "boolean" }, "aplRetention": { "type": "boolean" }, "aplItemType": { "type": "string" }, "aplJobAssemblyID": { "type": "integer", "format": "int32" }, "aplJobID": { "type": "string" }, "aplJobMaterialID": { "type": "integer", "format": "int32" }, "aplJobOperationID": { "type": "integer", "format": "int32" }, "aplJobType": { "type": "integer", "format": "int32" }, "aplLandedCostChargeID": { "type": "integer", "format": "int32" }, "aplLandedCostID": { "type": "string" }, "aplNonTaxReasonID": { "type": "string" }, "aplOrgPartID": { "type": "string" }, "aplOrgPartShortDescription": { "type": "string" }, "aplPartDescription": { "type": "string" }, "aplPartID": { "type": "string" }, "aplPartLongDescriptionRtf": { "type": "string" }, "aplPartLongDescriptionText": { "type": "string" }, "aplPartRevisionID": { "type": "string" }, "aplProjectAreaID": { "type": "string" }, "aplProjectID": { "type": "string" }, "aplPurchaseOrderID": { "type": "string" }, "aplPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "aplPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "aplPurchaseUnitCostBase": { "minimum": 0, "type": "number", "format": "double" }, "aplPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "aplPurchaseUnitOfMeasure": { "type": "string" }, "aplReceiptID": { "type": "string" }, "aplReceiptLineID": { "type": "integer", "format": "int32" }, "aplReceivedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "aplReceivedUnitOfMeasure": { "type": "string" }, "aplRetentionAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "aplRetentionAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "aplRetentionPercent": { "minimum": 0, "type": "number", "format": "double" }, "aplRetentionReleaseDate": { "type": "string", "format": "date-time" }, "aplRmaClaimID": { "type": "string" }, "aplRmaClaimLineID": { "type": "integer", "format": "int32" }, "aplRowVersion": { "type": "integer", "format": "int64" }, "aplSecondTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "aplSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "aplSecondTaxCodeID": { "type": "string" }, "aplApInvoiceLineID": { "type": "integer", "format": "int32" }, "aplSetupChargeBase": { "minimum": 0, "type": "number", "format": "double" }, "aplSetupChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "aplTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "aplTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "aplTaxCodeID": { "type": "string" }, "aplTotalExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "aplTotalExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPAPInvoiceLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPInvoiceLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPInvoiceMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPInvoiceMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPInvoiceMemoDto": { "required": [ "apiApInvoiceID", "apiMemoDate", "apiApInvoiceMemoID", "apiShortDescription" ], "type": "object", "properties": { "apiApInvoiceID": { "type": "string" }, "apiCreatedBy": { "type": "string" }, "apiCreatedDate": { "type": "string", "format": "date-time" }, "apiUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "apiLongDescriptionRtf": { "type": "string" }, "apiLongDescriptionText": { "type": "string" }, "apiMemoDate": { "type": "string", "format": "date-time" }, "apiRowVersion": { "type": "integer", "format": "int64" }, "apiApInvoiceMemoID": { "type": "integer", "format": "int32" }, "apiShortDescription": { "type": "string" }, "apiShowInApInvoices": { "type": "boolean" }, "apiShowInApPayments": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPAPInvoiceMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPInvoiceMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPInvoiceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPInvoiceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPInvoiceDto": { "required": [ "appApInvoiceID", "appDueDate", "appGlFiscalYearID", "appGlFiscalYearPeriodID", "appInvoiceDate", "appInvoiceType", "appSupplierOrganizationID" ], "type": "object", "properties": { "appApGlAccountID": { "type": "string" }, "appApInvoiceContactID": { "type": "string" }, "appApInvoiceLocationID": { "type": "string" }, "appApInvoiceID": { "type": "string" }, "appCreatedBy": { "type": "string" }, "appCreatedDate": { "type": "string", "format": "date-time" }, "appCreditApInvoiceID": { "type": "string" }, "appCreditDate": { "type": "string", "format": "date-time" }, "appCreditReasonID": { "type": "string" }, "appCurrencyRateID": { "type": "string" }, "appDiscountAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "appDiscountAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "appDiscountDueDate": { "type": "string", "format": "date-time" }, "appDueDate": { "type": "string", "format": "date-time" }, "appUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "appExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "appFreightAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "appFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "appFreightGlAccountID": { "type": "string" }, "appFreightTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "appFreightTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "appFreightTaxCodeID": { "type": "string" }, "appGlFiscalYearID": { "type": "integer", "format": "int32" }, "appGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "appInvoiceBalanceBase": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceCommentsRTF": { "type": "string" }, "appInvoiceCommentsText": { "type": "string" }, "appInvoiceDate": { "type": "string", "format": "date-time" }, "appInvoiceDescription": { "type": "string" }, "appInvoiceSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "appInvoiceType": { "type": "integer", "format": "int32" }, "appCustomRate": { "type": "boolean" }, "appOnHold": { "type": "boolean" }, "appOpenInvoiceLoad": { "type": "boolean" }, "appOverpayment": { "type": "boolean" }, "appPaidComplete": { "type": "boolean" }, "appPostedToGl": { "type": "boolean" }, "appTaxReportable": { "type": "boolean" }, "appOriginalExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "appOverPaymentHeaderID": { "type": "integer", "format": "int32" }, "appOverPaymentSessionID": { "type": "integer", "format": "int32" }, "appPaidDate": { "type": "string", "format": "date-time" }, "appPaymentTermID": { "type": "string" }, "appPlantDepartmentID": { "type": "string" }, "appPlantID": { "type": "string" }, "appPostedDate": { "type": "string", "format": "date-time" }, "appProjectID": { "type": "string" }, "appRetentionBalanceBase": { "minimum": 0, "type": "number", "format": "double" }, "appRetentionBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "appRetentionTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "appRetentionTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "appRowVersion": { "type": "integer", "format": "int64" }, "appSecondFreightTaxAmtBase": { "minimum": 0, "type": "number", "format": "double" }, "appSecondFreightTaxAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "appSecondFreightTaxCodeID": { "type": "string" }, "appSupplierInvoiceNumber": { "type": "string" }, "appSupplierOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPAPInvoiceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPInvoiceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPPaymentHeaderDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPPaymentHeaderDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPPaymentHeaderDto": { "required": [ "aptApPaymentSessionID", "aptPaymentType", "aptApPaymentHeaderID" ], "type": "object", "properties": { "aptApInvoiceContactID": { "type": "string" }, "aptApInvoiceLocationID": { "type": "string" }, "aptApPaymentSessionID": { "type": "integer", "format": "int32" }, "aptBankAccountName": { "type": "string" }, "aptBankAccountNumber": { "type": "string" }, "aptBankAccountType": { "type": "string" }, "aptBankInitials": { "type": "string" }, "aptBic": { "type": "string" }, "aptBsbNumber": { "type": "string" }, "aptCashGlAccountID": { "type": "string" }, "aptCreatedBy": { "type": "string" }, "aptCreatedCreditApInvoiceID": { "type": "string" }, "aptCreatedDate": { "type": "string", "format": "date-time" }, "aptCreditApInvoiceID": { "type": "string" }, "aptEftCode": { "type": "string" }, "aptEftDescription": { "type": "string" }, "aptEftNumber": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "aptEftParticulars": { "type": "string" }, "aptUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "aptExchangeAmount": { "minimum": 0, "type": "number", "format": "double" }, "aptExchangeGlAccountID": { "type": "string" }, "aptForm1099Box": { "type": "integer", "format": "int32" }, "aptGlFiscalYearID": { "type": "integer", "format": "int32" }, "aptGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "aptIban": { "type": "string" }, "aptCompleted": { "type": "boolean" }, "aptManualPayment": { "type": "boolean" }, "aptOpenPaymentLoad": { "type": "boolean" }, "aptOverpayment": { "type": "boolean" }, "aptPostedToGl": { "type": "boolean" }, "aptSuppressVoid": { "type": "boolean" }, "aptTaxReportable": { "type": "boolean" }, "aptVoidedPayment": { "type": "boolean" }, "aptLongDescriptionRtf": { "type": "string" }, "aptLongDescriptionText": { "type": "string" }, "aptPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "aptPaymentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "aptPaymentDate": { "type": "string", "format": "date-time" }, "aptPaymentMemo": { "type": "string" }, "aptPaymentNumber": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "aptPaymentType": { "type": "integer", "format": "int32" }, "aptRecurringPaymentID": { "type": "integer", "format": "int32" }, "aptRowVersion": { "type": "integer", "format": "int64" }, "aptApPaymentHeaderID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "aptShowAllInvoices": { "type": "boolean" }, "aptSupplierOrganizationID": { "type": "string" }, "aptVoidApPaymentHeaderID": { "type": "integer", "format": "int32" }, "aptVoidApPaymentSessionID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAPPaymentHeaderDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPPaymentHeaderDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPPaymentLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPPaymentLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPPaymentLineDto": { "required": [ "apnApPaymentHeaderID", "apnApPaymentSessionID", "apnExpenseGlAccountID", "apnApPaymentLineID" ], "type": "object", "properties": { "apnAdjustmentAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnAdjustmentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnAdjustmentGlAccountID": { "type": "string" }, "apnApInvoiceID": { "type": "string" }, "apnApPaymentHeaderID": { "type": "integer", "format": "int32" }, "apnApPaymentSessionID": { "type": "integer", "format": "int32" }, "apnArInvoiceID": { "type": "string" }, "apnBankAccountID": { "type": "string" }, "apnCreatedBy": { "type": "string" }, "apnCreatedDate": { "type": "string", "format": "date-time" }, "apnCurrencyRateID": { "type": "string" }, "apnDescription": { "type": "string" }, "apnDiscountAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnDiscountAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnDiscountGlAccountID": { "type": "string" }, "apnDiscountTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnDiscountTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnDiscountTaxCodeID": { "type": "string" }, "apnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "apnExchangeAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnExchangeGlAccountID": { "type": "string" }, "apnExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "apnExpenseGlAccountID": { "type": "string" }, "apnCompleted": { "type": "boolean" }, "apnCustomRate": { "type": "boolean" }, "apnOverpayment": { "type": "boolean" }, "apnPostedToGl": { "type": "boolean" }, "apnNonTaxReasonID": { "type": "string" }, "apnOriginalInvBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnOriginalInvoiceBalance": { "minimum": 0, "type": "number", "format": "double" }, "apnPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnPaymentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnRetentionPayAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnRetentionPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnRowVersion": { "type": "integer", "format": "int64" }, "apnSecondDiscountTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnSecondDiscountTaxCodeID": { "type": "string" }, "apnSecondDisTaxAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnSecondTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnSecondTaxCodeID": { "type": "string" }, "apnApPaymentLineID": { "type": "integer", "format": "int32" }, "apnTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnTaxCodeID": { "type": "string" }, "apnTotalDiscountAmount": { "minimum": 0, "type": "number", "format": "double" }, "apnTotalDiscountAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "apnUnrealisedExchangeAmt": { "minimum": 0, "type": "number", "format": "double" }, "apnUnrealisedExGlAccountID": { "type": "string" } } }, "ERPResponseMessageDto[ERPAPPaymentLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPPaymentLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAPPaymentSessionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAPPaymentSessionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAPPaymentSessionDto": { "required": [ "apsApGlAccountID", "apsGlFiscalYearID", "apsGlFiscalYearPeriodID", "apsPaymentDate", "apsApPaymentSessionID", "apsSessionType" ], "type": "object", "properties": { "apsApGlAccountID": { "type": "string" }, "apsArGlAccountID": { "type": "string" }, "apsBankAccountID": { "type": "string" }, "apsCashGlAccountID": { "type": "string" }, "apsCompletedDate": { "type": "string", "format": "date-time" }, "apsCreatedBy": { "type": "string" }, "apsCreatedDate": { "type": "string", "format": "date-time" }, "apsCurrencyRateID": { "type": "string" }, "apsEftDescription": { "type": "string" }, "apsEftReferenceNumber": { "type": "string" }, "apsEftSettlementDate": { "type": "string", "format": "date-time" }, "apsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "apsExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "apsGlFiscalYearID": { "type": "integer", "format": "int32" }, "apsGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "apsCompleted": { "type": "boolean" }, "apsCustomRate": { "type": "boolean" }, "apsOpenPaymentLoad": { "type": "boolean" }, "apsPaymentsPrinted": { "type": "boolean" }, "apsPostedToGl": { "type": "boolean" }, "apsPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "apsPaymentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "apsPaymentDate": { "type": "string", "format": "date-time" }, "apsPlantDepartmentID": { "type": "string" }, "apsPlantID": { "type": "string" }, "apsPostedDate": { "type": "string", "format": "date-time" }, "apsRowVersion": { "type": "integer", "format": "int64" }, "apsApPaymentSessionID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "apsSessionType": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAPPaymentSessionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAPPaymentSessionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARInvoiceLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARInvoiceLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARInvoiceLineDto": { "required": [ "arlArInvoiceID", "arlPartID", "arlPartShortDescription", "arlArInvoiceLineID" ], "type": "object", "properties": { "arlActualTotalCostOfGoodsSold": { "minimum": 0, "type": "number", "format": "double" }, "arlActualTotalLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualTotalMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualTotalOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualTotalSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualUnitCostOfGoodsSold": { "minimum": 0, "type": "number", "format": "double" }, "arlActualUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "arlActualUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "arlAmtForResellerCommission": { "minimum": 0, "type": "number", "format": "double" }, "arlAmtForSalesCommission": { "minimum": 0, "type": "number", "format": "double" }, "arlArInvoiceID": { "type": "string" }, "arlArRecurringInvoiceID": { "type": "integer", "format": "int32" }, "arlArRecurringInvoiceLineID": { "type": "integer", "format": "int32" }, "arlAssetAdjustmentID": { "type": "integer", "format": "int32" }, "arlAssetID": { "type": "string" }, "arlCallID": { "type": "string" }, "arlCogsCalculatedDate": { "type": "string", "format": "date-time" }, "arlCommissionAmount": { "minimum": 0, "type": "number", "format": "double" }, "arlCommissionRate": { "minimum": 0, "type": "number", "format": "double" }, "arlCreatedBy": { "type": "string" }, "arlCreatedDate": { "type": "string", "format": "date-time" }, "arlCustomerPo": { "type": "string" }, "arlDepositAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlDepositAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlDepositBalanceBase": { "minimum": 0, "type": "number", "format": "double" }, "arlDepositBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlDepositInvoiceID": { "type": "string" }, "arlDepositInvoiceLineID": { "type": "integer", "format": "int32" }, "arlDepositTransferredBase": { "minimum": 0, "type": "number", "format": "double" }, "arlDepositTransferredForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlDiscountPercent": { "minimum": 0, "type": "number", "format": "double" }, "arlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "arlEstTotalCostOfGoodsSold": { "minimum": 0, "type": "number", "format": "double" }, "arlEstTotalLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstTotalMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstTotalOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstTotalSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstUnitCostOfGoodsSold": { "minimum": 0, "type": "number", "format": "double" }, "arlEstUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "arlEstUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "arlExtendedDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlExtendedDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlExtendedPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "arlExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlFinanceSourceInvoiceID": { "type": "string" }, "arlFreightAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlFullExtendedPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "arlFullExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlFullUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "arlFullUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlInvoiceQuantity": { "minimum": 0, "type": "number", "format": "double" }, "arlAvalaraIgnoreLine": { "type": "boolean" }, "arlCogsPostedToGl": { "type": "boolean" }, "arlDeliveryInvoicedComplete": { "type": "boolean" }, "arlDepositLine": { "type": "boolean" }, "arlIncludeTaxInRetention": { "type": "boolean" }, "arlIntraCompanyPosted": { "type": "boolean" }, "arlPayCommission": { "type": "boolean" }, "arlPostedToGl": { "type": "boolean" }, "arlRetention": { "type": "boolean" }, "arlJobAssemblyID": { "type": "integer", "format": "int32" }, "arlJobID": { "type": "string" }, "arlJobMaterialID": { "type": "integer", "format": "int32" }, "arlLineType": { "type": "integer", "format": "int32" }, "arlNonTaxReasonID": { "type": "string" }, "arlOrderQuantity": { "minimum": 0, "type": "number", "format": "double" }, "arlOrgPartID": { "type": "string" }, "arlOrgPartShortDescription": { "type": "string" }, "arlPartGroupID": { "type": "string" }, "arlPartID": { "type": "string" }, "arlPartLongDescriptionRtf": { "type": "string" }, "arlPartLongDescriptionText": { "type": "string" }, "arlPartRevisionID": { "type": "string" }, "arlPartShortDescription": { "type": "string" }, "arlProjectAreaID": { "type": "string" }, "arlProjectID": { "type": "string" }, "arlRetentionAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlRetentionAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlRetentionDueDate": { "type": "string", "format": "date-time" }, "arlRetentionPercent": { "minimum": 0, "type": "number", "format": "double" }, "arlRmaClaimID": { "type": "string" }, "arlRmaClaimLineID": { "type": "integer", "format": "int32" }, "arlRmaReceiptID": { "type": "string" }, "arlRmaReceiptLineID": { "type": "integer", "format": "int32" }, "arlRowVersion": { "type": "integer", "format": "int64" }, "arlSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "arlSalesOrderID": { "type": "string" }, "arlSalesOrderLineID": { "type": "integer", "format": "int32" }, "arlSecondTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlSecondTaxCodeID": { "type": "string" }, "arlArInvoiceLineID": { "type": "integer", "format": "int32" }, "arlShipmentID": { "type": "string" }, "arlShipmentLineID": { "type": "integer", "format": "int32" }, "arlTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlTaxCodeID": { "type": "string" }, "arlTaxDate": { "type": "string", "format": "date-time" }, "arlUnitDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "arlUnitDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arlUnitOfMeasure": { "type": "string" }, "arlUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "arlUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPARInvoiceLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARInvoiceLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARInvoiceMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARInvoiceMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARInvoiceMemoDto": { "required": [ "ariArInvoiceID", "ariMemoDate", "ariArInvoiceMemoID", "ariShortDescription" ], "type": "object", "properties": { "ariArInvoiceID": { "type": "string" }, "ariCreatedBy": { "type": "string" }, "ariCreatedDate": { "type": "string", "format": "date-time" }, "ariUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ariLongDescriptionRtf": { "type": "string" }, "ariLongDescriptionText": { "type": "string" }, "ariMemoDate": { "type": "string", "format": "date-time" }, "ariRowVersion": { "type": "integer", "format": "int64" }, "ariArInvoiceMemoID": { "type": "integer", "format": "int32" }, "ariShortDescription": { "type": "string" }, "ariShowInArInvoices": { "type": "boolean" }, "ariShowInArPayments": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPARInvoiceMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARInvoiceMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARInvoiceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARInvoiceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARInvoiceDto": { "required": [ "arpArInvoiceID", "arpCustomerOrganizationID", "arpDueDate", "arpGlFiscalYearID", "arpGlFiscalYearPeriodID", "arpInvoiceDate", "arpInvoiceType", "arpOrderDate", "arpShipOrganizationID" ], "type": "object", "properties": { "arpArGlAccountID": { "type": "string" }, "arpArInvoiceContactID": { "type": "string" }, "arpArInvoiceLocationID": { "type": "string" }, "arpArInvoiceID": { "type": "string" }, "arpCommissionAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arpCreatedBy": { "type": "string" }, "arpCreatedDate": { "type": "string", "format": "date-time" }, "arpCreditArInvoiceID": { "type": "string" }, "arpCreditDate": { "type": "string", "format": "date-time" }, "arpCreditReasonID": { "type": "string" }, "arpCurrencyRateID": { "type": "string" }, "arpCustomerOrganizationID": { "type": "string" }, "arpDepositAppliedBase": { "minimum": 0, "type": "number", "format": "double" }, "arpDepositAppliedForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpDepositBalanceBase": { "minimum": 0, "type": "number", "format": "double" }, "arpDepositBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpDepositGlAccountID": { "type": "string" }, "arpDepositTransferredBase": { "minimum": 0, "type": "number", "format": "double" }, "arpDepositTransferredForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpDiscountDueDate": { "type": "string", "format": "date-time" }, "arpDiscountGlAccountID": { "type": "string" }, "arpDiscountTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpDiscountTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpDueDate": { "type": "string", "format": "date-time" }, "arpEdiTransferredDate": { "type": "string", "format": "date-time" }, "arpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "arpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "arpFreeOnBoardDescription": { "type": "string" }, "arpFreightAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightGlAccountID": { "type": "string" }, "arpFreightSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightTaxCodeID": { "type": "string" }, "arpFreightTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpFreightTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpFullInvoiceSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpFullInvoiceSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpGlFiscalYearID": { "type": "integer", "format": "int32" }, "arpGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "arpIntraCompanyPostedDate": { "type": "string", "format": "date-time" }, "arpInvoiceBalanceBase": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceCommentsRTF": { "type": "string" }, "arpInvoiceCommentsText": { "type": "string" }, "arpInvoiceDate": { "type": "string", "format": "date-time" }, "arpInvoicePaidBase": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoicePaidForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpInvoiceType": { "type": "integer", "format": "int32" }, "arpAvalaraOverrideTax": { "type": "boolean" }, "arpAvalaraTaxCalculated": { "type": "boolean" }, "arpCustomRate": { "type": "boolean" }, "arpDepositCredit": { "type": "boolean" }, "arpEdiTransferred": { "type": "boolean" }, "arpIncludeFreightInPrice": { "type": "boolean" }, "arpIncludeTaxInRetention": { "type": "boolean" }, "arpIntraCompany": { "type": "boolean" }, "arpIntraCompanyPosted": { "type": "boolean" }, "arpOnHold": { "type": "boolean" }, "arpOpenInvoiceLoad": { "type": "boolean" }, "arpOverpayment": { "type": "boolean" }, "arpPaidComplete": { "type": "boolean" }, "arpPostedToGl": { "type": "boolean" }, "arpReadyToPrint": { "type": "boolean" }, "arpRecurringInvoice": { "type": "boolean" }, "arpRefundCheckRequired": { "type": "boolean" }, "arpLineCommissionTotal": { "minimum": 0, "type": "number", "format": "double" }, "arpOrderDate": { "type": "string", "format": "date-time" }, "arpOriginalExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "arpOverPaymentHeaderID": { "type": "integer", "format": "int32" }, "arpOverPaymentSessionID": { "type": "integer", "format": "int32" }, "arpPaidDate": { "type": "string", "format": "date-time" }, "arpPaymentTermID": { "type": "string" }, "arpPlantDepartmentID": { "type": "string" }, "arpPlantID": { "type": "string" }, "arpPointOfSaleTerminalID": { "type": "string" }, "arpPostedDate": { "type": "string", "format": "date-time" }, "arpProjectID": { "type": "string" }, "arpResellerCommissionAmount": { "minimum": 0, "type": "number", "format": "double" }, "arpResellerCommissionRate": { "minimum": 0, "type": "number", "format": "double" }, "arpResellerContactID": { "type": "string" }, "arpResellerLocationID": { "type": "string" }, "arpResellerOrganizationID": { "type": "string" }, "arpRetentionBalanceBase": { "minimum": 0, "type": "number", "format": "double" }, "arpRetentionBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpRetentionPaidBase": { "minimum": 0, "type": "number", "format": "double" }, "arpRetentionPaidForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpRetentionTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpRetentionTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpRowVersion": { "type": "integer", "format": "int64" }, "arpSalesCommissionTotal": { "minimum": 0, "type": "number", "format": "double" }, "arpSalesGlAccountID": { "type": "string" }, "arpSecondFreightTaxAmtBase": { "minimum": 0, "type": "number", "format": "double" }, "arpSecondFreightTaxAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpSecondFreightTaxCodeID": { "type": "string" }, "arpShipContactID": { "type": "string" }, "arpShipLocationID": { "type": "string" }, "arpShipOrganizationID": { "type": "string" }, "arpShippingMethodID": { "type": "string" }, "arpShippingPaymentTypeID": { "type": "string" }, "arpSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "arpStandardMessageID": { "type": "string" }, "arpTaxDate": { "type": "string", "format": "date-time" }, "arpTaxSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "arpTaxSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "arpTotalForResellerCommission": { "minimum": 0, "type": "number", "format": "double" }, "arpTotalForSalesCommission": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPARInvoiceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARInvoiceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARInvoiceSalesPersonDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARInvoiceSalesPersonDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARInvoiceSalesPersonDto": { "required": [ "arjArInvoiceID", "arjSalesEmployeeID", "arjSequenceID" ], "type": "object", "properties": { "arjAmount": { "minimum": 0, "type": "number", "format": "double" }, "arjArInvoiceID": { "type": "string" }, "arjCreatedBy": { "type": "string" }, "arjCreatedDate": { "type": "string", "format": "date-time" }, "arjUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "arjPostedToGl": { "type": "boolean" }, "arjPercent": { "minimum": 0, "type": "number", "format": "double" }, "arjRate": { "minimum": 0, "type": "number", "format": "double" }, "arjRowVersion": { "type": "integer", "format": "int64" }, "arjSalesEmployeeID": { "type": "string" }, "arjSequenceID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPARInvoiceSalesPersonDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARInvoiceSalesPersonDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARPaymentHeaderDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARPaymentHeaderDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARPaymentHeaderDto": { "required": [ "artArPaymentSessionID", "artReceiptType", "artArPaymentHeaderID" ], "type": "object", "properties": { "artArGlAccountID": { "type": "string" }, "artArInvoiceContactID": { "type": "string" }, "artArInvoiceLocationID": { "type": "string" }, "artArPaymentSessionID": { "type": "integer", "format": "int32" }, "artBankAccountName": { "type": "string" }, "artBankAccountNumber": { "type": "string" }, "artBankInitials": { "type": "string" }, "artBsbNumber": { "type": "string" }, "artCashGlAccountID": { "type": "string" }, "artCreatedBy": { "type": "string" }, "artCreatedCreditArInvoiceID": { "type": "string" }, "artCreatedDate": { "type": "string", "format": "date-time" }, "artCreditArInvoiceID": { "type": "string" }, "artCustomerOrganizationID": { "type": "string" }, "artCustomerPaymentNumber": { "type": "string" }, "artDescription": { "type": "string" }, "artUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "artExchangeAmount": { "minimum": 0, "type": "number", "format": "double" }, "artExchangeGlAccountID": { "type": "string" }, "artGlAccountID": { "type": "string" }, "artGlFiscalYearID": { "type": "integer", "format": "int32" }, "artGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "artAvalaraTaxCalculated": { "type": "boolean" }, "artNet1PaymentProcessed": { "type": "boolean" }, "artOpenPaymentLoad": { "type": "boolean" }, "artPostedToGl": { "type": "boolean" }, "artVoidedPayment": { "type": "boolean" }, "artLongDescriptionRtf": { "type": "string" }, "artLongDescriptionText": { "type": "string" }, "artNonTaxReasonID": { "type": "string" }, "artPaymentMethod": { "type": "integer", "format": "int32" }, "artReceiptAmount": { "minimum": 0, "type": "number", "format": "double" }, "artReceiptAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "artReceiptDate": { "type": "string", "format": "date-time" }, "artReceiptType": { "type": "integer", "format": "int32" }, "artRowVersion": { "type": "integer", "format": "int64" }, "artSecondTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "artSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "artSecondTaxCodeID": { "type": "string" }, "artArPaymentHeaderID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "artShowAllInvoices": { "type": "boolean" }, "artTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "artTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "artTaxCodeID": { "type": "string" }, "artVoidArPaymentHeaderId": { "type": "integer", "format": "int32" }, "artVoidArPaymentSessionID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPARPaymentHeaderDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARPaymentHeaderDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARPaymentLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARPaymentLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARPaymentLineDto": { "required": [ "arnArPaymentHeaderID", "arnArPaymentSessionID", "arnArPaymentLineID" ], "type": "object", "properties": { "arnAdjustmentAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnAdjustmentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnAdjustmentGlAccountID": { "type": "string" }, "arnApInvoiceID": { "type": "string" }, "arnArInvoiceID": { "type": "string" }, "arnArPaymentEPayID": { "type": "integer", "format": "int32" }, "arnArPaymentHeaderID": { "type": "integer", "format": "int32" }, "arnArPaymentSessionID": { "type": "integer", "format": "int32" }, "arnCreatedBy": { "type": "string" }, "arnCreatedDate": { "type": "string", "format": "date-time" }, "arnDiscountAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnDiscountAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnDiscountGlAccountID": { "type": "string" }, "arnDiscountTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnDiscountTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnDiscountTaxCodeID": { "type": "string" }, "arnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "arnExchangeAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnExchangeGlAccountID": { "type": "string" }, "arnAvalaraTaxCalculated": { "type": "boolean" }, "arnOverpayment": { "type": "boolean" }, "arnPostedToGl": { "type": "boolean" }, "arnNonTaxReasonID": { "type": "string" }, "arnOriginalInvBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnOriginalInvoiceBalance": { "minimum": 0, "type": "number", "format": "double" }, "arnPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnPaymentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnRetentionPayAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnRetentionPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnRowVersion": { "type": "integer", "format": "int64" }, "arnSecondDiscountTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnSecondDiscountTaxCodeID": { "type": "string" }, "arnSecondDisTaxAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnSecondTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnSecondTaxCodeID": { "type": "string" }, "arnArPaymentLineID": { "type": "integer", "format": "int32" }, "arnTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnTaxCodeID": { "type": "string" }, "arnTotalDiscountAmount": { "minimum": 0, "type": "number", "format": "double" }, "arnTotalDiscountAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "arnUnrealisedExchangeAmt": { "minimum": 0, "type": "number", "format": "double" }, "arnUnrealisedExGlAccountID": { "type": "string" } } }, "ERPResponseMessageDto[ERPARPaymentLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARPaymentLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPARPaymentSessionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPARPaymentSessionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPARPaymentSessionDto": { "required": [ "arsArGlAccountID", "arsGlFiscalYearID", "arsGlFiscalYearPeriodID", "arsReceiptDate", "arsArPaymentSessionID" ], "type": "object", "properties": { "arsApDiscountGlAccountID": { "type": "string" }, "arsApGlAccountID": { "type": "string" }, "arsArGlAccountID": { "type": "string" }, "arsBankAccountID": { "type": "string" }, "arsCashGlAccountID": { "type": "string" }, "arsCreatedBy": { "type": "string" }, "arsCreatedDate": { "type": "string", "format": "date-time" }, "arsCurrencyRateID": { "type": "string" }, "arsDepositAmount": { "minimum": 0, "type": "number", "format": "double" }, "arsDepositAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "arsDiscountGlAccountID": { "type": "string" }, "arsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "arsExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "arsGlFiscalYearID": { "type": "integer", "format": "int32" }, "arsGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "arsAvalaraTaxCalculated": { "type": "boolean" }, "arsCustomRate": { "type": "boolean" }, "arsGroupBySettlement": { "type": "boolean" }, "arsOpenPaymentLoad": { "type": "boolean" }, "arsPostedToGl": { "type": "boolean" }, "arsPlantDepartmentID": { "type": "string" }, "arsPlantID": { "type": "string" }, "arsPostedDate": { "type": "string", "format": "date-time" }, "arsReceiptDate": { "type": "string", "format": "date-time" }, "arsRowVersion": { "type": "integer", "format": "int64" }, "arsArPaymentSessionID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "arsSettlementEndTime": { "type": "string", "format": "date-time" }, "arsSettlementStartTime": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPARPaymentSessionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPARPaymentSessionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetAdjustmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetAdjustmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAssetAdjustmentDto": { "required": [ "faaAdjustmentDate", "faaAdjustmentType", "faaAssetID", "faaQuantity", "faaAssetAdjustmentID" ], "type": "object", "properties": { "faaAccumulatedDepreciation": { "minimum": 0, "type": "number", "format": "double" }, "faaAdjustmentDate": { "type": "string", "format": "date-time" }, "faaAdjustmentType": { "type": "string" }, "faaArInvoiceContactID": { "type": "string" }, "faaArInvoiceLocationID": { "type": "string" }, "faaAssetID": { "type": "string" }, "faaAuthorizedByEmployeeID": { "type": "string" }, "faaClosingPercent": { "minimum": 0, "type": "number", "format": "double" }, "faaClosingPeriodDepreciation": { "minimum": 0, "type": "number", "format": "double" }, "faaCreatedBy": { "type": "string" }, "faaCreatedDate": { "type": "string", "format": "date-time" }, "faaCurrencyRateID": { "type": "string" }, "faaCustomerOrganizationID": { "type": "string" }, "faaDepreciationThisYear": { "minimum": 0, "type": "number", "format": "double" }, "faaDestinationPlantID": { "type": "string" }, "faaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "faaExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "faaGlFiscalYearID": { "type": "integer", "format": "int32" }, "faaGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "faaCustomRate": { "type": "boolean" }, "faaPostedToGl": { "type": "boolean" }, "faaLongDescriptionRtf": { "type": "string" }, "faaLongDescriptionText": { "type": "string" }, "faaNetAssetValue": { "minimum": 0, "type": "number", "format": "double" }, "faaOpeningAssetValue": { "minimum": 0, "type": "number", "format": "double" }, "faaPostedDate": { "type": "string", "format": "date-time" }, "faaProfitOrLoss": { "minimum": 0, "type": "number", "format": "double" }, "faaQuantity": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "faaRowVersion": { "type": "integer", "format": "int64" }, "faaAssetAdjustmentID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "faaSourcePlantID": { "type": "string" }, "faaValue": { "minimum": 0, "type": "number", "format": "double" }, "faaValueForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPAssetAdjustmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetAdjustmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetLowValuePoolDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetLowValuePoolDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAssetLowValuePoolDto": { "required": [ "favPoolYearID" ], "type": "object", "properties": { "favClosedDate": { "type": "string", "format": "date-time" }, "favCreatedBy": { "type": "string" }, "favCreatedDate": { "type": "string", "format": "date-time" }, "favEndingBalance": { "minimum": 0, "type": "number", "format": "double" }, "favUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "favHighRate": { "minimum": 0, "type": "number", "format": "double" }, "favHighRateDepreciation": { "minimum": 0, "type": "number", "format": "double" }, "favImprovement": { "minimum": 0, "type": "number", "format": "double" }, "favClosed": { "type": "boolean" }, "favLowCostAddition": { "minimum": 0, "type": "number", "format": "double" }, "favLowRate": { "minimum": 0, "type": "number", "format": "double" }, "favLowRateDepreciation": { "minimum": 0, "type": "number", "format": "double" }, "favLowValueAddition": { "minimum": 0, "type": "number", "format": "double" }, "favOpeningBalance": { "minimum": 0, "type": "number", "format": "double" }, "favPoolYearID": { "type": "integer", "format": "int32" }, "favRowVersion": { "type": "integer", "format": "int64" }, "favTermination": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPAssetLowValuePoolDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetLowValuePoolDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAssetMemoDto": { "required": [ "fakAssetID", "fakMemoDate", "fakAssetMemoID", "fakShortDescription" ], "type": "object", "properties": { "fakAssetID": { "type": "string" }, "fakCreatedBy": { "type": "string" }, "fakCreatedDate": { "type": "string", "format": "date-time" }, "fakUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fakLongDescriptionRtf": { "type": "string" }, "fakLongDescriptionText": { "type": "string" }, "fakMemoDate": { "type": "string", "format": "date-time" }, "fakRowVersion": { "type": "integer", "format": "int64" }, "fakAssetMemoID": { "type": "integer", "format": "int32" }, "fakShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPAssetMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetPoolTransactionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetPoolTransactionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAssetPoolTransactionDto": { "required": [ "fawAssetID", "fawPoolTransactionID", "fawPoolYearID" ], "type": "object", "properties": { "fawAmount": { "minimum": 0, "type": "number", "format": "double" }, "fawAssetAdjustmentID": { "type": "integer", "format": "int32" }, "fawAssetID": { "type": "string" }, "fawCreatedBy": { "type": "string" }, "fawCreatedDate": { "type": "string", "format": "date-time" }, "fawUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fawPoolTransactionID": { "type": "integer", "format": "int32" }, "fawPoolYearID": { "type": "integer", "format": "int32" }, "fawRowVersion": { "type": "integer", "format": "int64" }, "fawTransactionDate": { "type": "string", "format": "date-time" }, "fawTransactionType": { "type": "string" } } }, "ERPResponseMessageDto[ERPAssetPoolTransactionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetPoolTransactionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAssetDto": { "required": [ "fapAssetTypeID", "fapAssetID", "fapDescription", "fapItemType", "fapLocation", "fapPurchaseType", "fapQuantity" ], "type": "object", "properties": { "fapApInvoiceID": { "type": "string" }, "fapApInvoiceLineID": { "type": "integer", "format": "int32" }, "fapAssetTypeID": { "type": "string" }, "fapBookDepreciationEndDate": { "type": "string", "format": "date-time" }, "fapBookDepreciationRate": { "minimum": 0, "type": "number", "format": "double" }, "fapBookEffectiveLife": { "minimum": 0, "type": "number", "format": "double" }, "fapBookStartValue": { "minimum": 0, "type": "number", "format": "double" }, "fapAssetID": { "type": "string" }, "fapCreatedBy": { "type": "string" }, "fapCreatedDate": { "type": "string", "format": "date-time" }, "fapDeemedValue": { "minimum": 0, "type": "number", "format": "double" }, "fapDepreciationLimit": { "minimum": 0, "type": "number", "format": "double" }, "fapDepreciationStartDate": { "type": "string", "format": "date-time" }, "fapDescription": { "type": "string" }, "fapDisposalDate": { "type": "string", "format": "date-time" }, "fapDisposalValue": { "minimum": 0, "type": "number", "format": "double" }, "fapUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fapEstimatedProductionUnits": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "fapFinanceOrganizationID": { "type": "string" }, "fapInServiceDate": { "type": "string", "format": "date-time" }, "fapLowCostAsset": { "type": "boolean" }, "fapLowValueAssetInPool": { "type": "boolean" }, "fapItemType": { "type": "string" }, "fapLeaseExpiryDate": { "type": "string", "format": "date-time" }, "fapLeaseMonths": { "type": "integer", "format": "int32" }, "fapLocation": { "type": "string" }, "fapLongDescriptionRtf": { "type": "string" }, "fapLongDescriptionText": { "type": "string" }, "fapPaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "fapPlantID": { "type": "string" }, "fapPurchaseDate": { "type": "string", "format": "date-time" }, "fapPurchaseOrderID": { "type": "string" }, "fapPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "fapPurchaseType": { "type": "string" }, "fapPurchaseValue": { "minimum": 0, "type": "number", "format": "double" }, "fapQuantity": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "fapReceiptDate": { "type": "string", "format": "date-time" }, "fapReceiptID": { "type": "string" }, "fapReceiptLineID": { "type": "integer", "format": "int32" }, "fapResidualAmount": { "minimum": 0, "type": "number", "format": "double" }, "fapRowVersion": { "type": "integer", "format": "int64" }, "fapSerialNumber": { "type": "string" }, "fapStartYearInPool": { "type": "integer", "format": "int32" }, "fapStatus": { "type": "string" }, "fapSupplierOrganizationID": { "type": "string" }, "fapTaxableUsePercentage": { "minimum": 0, "type": "number", "format": "double" }, "fapTaxDepreciationEndDate": { "type": "string", "format": "date-time" }, "fapTaxDepreciationRate": { "minimum": 0, "type": "number", "format": "double" }, "fapTaxEffectiveLife": { "minimum": 0, "type": "number", "format": "double" }, "fapTaxStartValue": { "minimum": 0, "type": "number", "format": "double" }, "fapWorkCenterID": { "type": "string" } } }, "ERPResponseMessageDto[ERPAssetDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetScheduleDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetScheduleDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPAssetScheduleDto": { "required": [ "fasAssetID", "fasGlFiscalYearID", "fasGlFiscalYearPeriodID", "fasAssetScheduleID", "fasType" ], "type": "object", "properties": { "fasActualProductionUnits": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "fasAdditionalAssetAmount": { "minimum": 0, "type": "number", "format": "double" }, "fasAssetID": { "type": "string" }, "fasClosingAccumBalance": { "minimum": 0, "type": "number", "format": "double" }, "fasClosingAssetValue": { "minimum": 0, "type": "number", "format": "double" }, "fasCreatedBy": { "type": "string" }, "fasCreatedDate": { "type": "string", "format": "date-time" }, "fasDepreciationAmount": { "minimum": 0, "type": "number", "format": "double" }, "fasUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fasEstimatedProductionUnits": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "fasGlFiscalYearID": { "type": "integer", "format": "int32" }, "fasGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "fasPostedToGl": { "type": "boolean" }, "fasNetAssetValue": { "minimum": 0, "type": "number", "format": "double" }, "fasOpeningAccumBalance": { "minimum": 0, "type": "number", "format": "double" }, "fasOpeningAssetValue": { "minimum": 0, "type": "number", "format": "double" }, "fasRowVersion": { "type": "integer", "format": "int64" }, "fasAssetScheduleID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "fasSubtractAssetAmount": { "minimum": 0, "type": "number", "format": "double" }, "fasType": { "type": "string" }, "fasWritebackAmount": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPAssetScheduleDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetScheduleDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetTypeMethodDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetTypeMethodDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAssetTypeMethodDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetTypeMethodDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetTypePlantDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetTypePlantDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAssetTypePlantDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetTypePlantDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPAssetTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPAssetTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPAssetTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPAssetTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPBankAccountDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPBankAccountDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPBankAccountDto": { "required": [ "glnBankName", "glnCashGlAccountID", "glnBankAccountID", "glnDescription" ], "type": "object", "properties": { "glnBankAccountName": { "type": "string" }, "glnBankAccountNumber": { "type": "string" }, "glnBankInitials": { "type": "string" }, "glnBankName": { "type": "string" }, "glnBic": { "type": "string" }, "glnBsbNumber": { "type": "string" }, "glnCanadianEftType": { "type": "string" }, "glnCashGlAccountID": { "type": "string" }, "glnBankAccountID": { "type": "string" }, "glnCreatedBy": { "type": "string" }, "glnCreatedDate": { "type": "string", "format": "date-time" }, "glnCurrencyRateID": { "type": "string" }, "glnDataCenterCode": { "maximum": 99999, "minimum": 0, "type": "number", "format": "double" }, "glnDescription": { "type": "string" }, "glnDirectEntryUserID": { "type": "string" }, "glnDirectEntryUserName": { "type": "string" }, "glnEftApDescription": { "type": "string" }, "glnEftCompanyID": { "type": "string" }, "glnEftCompanyName": { "type": "string" }, "glnEftDiscretionaryData": { "type": "string" }, "glnEftFileID": { "type": "string" }, "glnEftFileIDModifier": { "type": "string" }, "glnEftFileLocation": { "type": "string" }, "glnEftPayrollDescription": { "type": "string" }, "glnEftReferenceCode": { "type": "string" }, "glnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glnFileCreationNumber": { "type": "integer", "format": "int32" }, "glnIban": { "type": "string" }, "glnInactiveDate": { "type": "string", "format": "date-time" }, "glnAChFormat": { "type": "boolean" }, "glnInactive": { "type": "boolean" }, "glnEftCreateOffsettingDebit": { "type": "boolean" }, "glnPayrollOnly": { "type": "boolean" }, "glnLanguageCode": { "type": "string" }, "glnNextEftNumber": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "glnNextPaymentNumber": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "glnNZEftType": { "type": "string" }, "glnOrganizationID": { "type": "string" }, "glnRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPBankAccountDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPBankAccountDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPBankEntryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPBankEntryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPBankEntryDto": { "required": [ "gleEntryType", "gleBankEntryID", "gleSource" ], "type": "object", "properties": { "gleApPaymentHeaderID": { "type": "integer", "format": "int32" }, "gleApPaymentSessionID": { "type": "integer", "format": "int32" }, "gleArPaymentHeaderID": { "type": "integer", "format": "int32" }, "gleArPaymentSessionID": { "type": "integer", "format": "int32" }, "gleBankStatementID": { "type": "integer", "format": "int32" }, "gleCashGlAccountID": { "type": "string" }, "gleCreatedBy": { "type": "string" }, "gleCreatedDate": { "type": "string", "format": "date-time" }, "gleCurrencyRateID": { "type": "string" }, "gleDescription": { "type": "string" }, "gleEftReferenceNumber": { "type": "string" }, "gleEntryType": { "type": "integer", "format": "int32" }, "gleUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gleExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "gleGlAccountID": { "type": "string" }, "gleGlFiscalYearID": { "type": "integer", "format": "int32" }, "gleGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "gleGlJournalID": { "type": "integer", "format": "int32" }, "gleGlJournalLineID": { "type": "integer", "format": "int32" }, "gleCleared": { "type": "boolean" }, "gleCustomRate": { "type": "boolean" }, "gleDoNotUpdateGl": { "type": "boolean" }, "glePostedToGl": { "type": "boolean" }, "gleUnpresentedPayment": { "type": "boolean" }, "gleNonTaxReasonID": { "type": "string" }, "gleOrganizationID": { "type": "string" }, "gleOriginalAmount": { "minimum": 0, "type": "number", "format": "double" }, "gleOriginalAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "glePaymentAmount": { "minimum": 0, "type": "number", "format": "double" }, "glePaymentAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "glePaymentDate": { "type": "string", "format": "date-time" }, "glePaymentNumber": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "glePayrollHeaderID": { "type": "integer", "format": "int32" }, "glePayrollSessionID": { "type": "integer", "format": "int32" }, "glePayType": { "type": "integer", "format": "int32" }, "glePresentedDate": { "type": "string", "format": "date-time" }, "gleRowVersion": { "type": "integer", "format": "int64" }, "gleBankEntryID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "gleSource": { "type": "integer", "format": "int32" }, "gleTaxAmount": { "minimum": 0, "type": "number", "format": "double" }, "gleTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "gleTaxCodeID": { "type": "string" }, "gleTransactionDate": { "type": "string", "format": "date-time" }, "gleVarianceAmount": { "minimum": 0, "type": "number", "format": "double" }, "gleVarianceAmountForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPBankEntryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPBankEntryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPBankStatementDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPBankStatementDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPBankStatementDto": { "required": [ "glsBankStatementReference", "glsCashGlAccountID", "glsEndingDate", "glsGlFiscalYearID", "glsOpeningDate", "glsBankStatementID" ], "type": "object", "properties": { "glsBankAccountID": { "type": "string" }, "glsBankStatementReference": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "glsCashGlAccountID": { "type": "string" }, "glsCreatedBy": { "type": "string" }, "glsCreatedDate": { "type": "string", "format": "date-time" }, "glsCurrencyRateID": { "type": "string" }, "glsEndingBalance": { "minimum": 0, "type": "number", "format": "double" }, "glsEndingBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "glsEndingDate": { "type": "string", "format": "date-time" }, "glsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glsExchangeAmount": { "minimum": 0, "type": "number", "format": "double" }, "glsExchangeGlAccountID": { "type": "string" }, "glsExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "glsGlFiscalYearID": { "type": "integer", "format": "int32" }, "glsCustomRate": { "type": "boolean" }, "glsPostedToGl": { "type": "boolean" }, "glsOpeningBalance": { "minimum": 0, "type": "number", "format": "double" }, "glsOpeningBalanceForeign": { "minimum": 0, "type": "number", "format": "double" }, "glsOpeningDate": { "type": "string", "format": "date-time" }, "glsPostedDate": { "type": "string", "format": "date-time" }, "glsRowVersion": { "type": "integer", "format": "int64" }, "glsBankStatementID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "glsShowTransactions": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPBankStatementDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPBankStatementDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPExpenseAccountSplitDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPExpenseAccountSplitDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPExpenseAccountSplitDto": { "required": [ "xazExpenseAccountSplitID", "xazExpenseGlAccountID", "xazSequence" ], "type": "object", "properties": { "xazExpenseAccountSplitID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xazCreatedBy": { "type": "string" }, "xazCreatedDate": { "type": "string", "format": "date-time" }, "xazExpenseGlAccountID": { "type": "string" }, "xazLandedCostCategoryID": { "type": "string" }, "xazPartID": { "type": "string" }, "xazPartRevisionID": { "type": "string" }, "xazPercent": { "minimum": 0, "type": "number", "format": "double" }, "xazRowVersion": { "type": "integer", "format": "int64" }, "xazSequence": { "type": "integer", "format": "int32" }, "xazSupplierOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPExpenseAccountSplitDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPExpenseAccountSplitDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLAccountDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLAccountDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLAccountDto": { "required": [ "glaGlAccountID", "glaGlChartID", "glaGlDepartmentID", "glaGlDivisionID" ], "type": "object", "properties": { "glaGlAccountID": { "type": "string" }, "glaCreatedBy": { "type": "string" }, "glaCreatedDate": { "type": "string", "format": "date-time" }, "glaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glaExternalGlCode": { "type": "string" }, "glaGlChartID": { "type": "string" }, "glaGlDepartmentID": { "type": "string" }, "glaGlDivisionID": { "type": "string" }, "glaInactiveDate": { "type": "string", "format": "date-time" }, "glaInactive": { "type": "boolean" }, "glaRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLAccountDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLAccountDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLCategoryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLCategoryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLCategoryDto": { "required": [ "gltCategoryType", "gltGlCategoryID", "gltDescription" ], "type": "object", "properties": { "gltCategoryType": { "type": "integer", "format": "int32" }, "gltGlCategoryID": { "type": "string" }, "gltCreatedBy": { "type": "string" }, "gltCreatedDate": { "type": "string", "format": "date-time" }, "gltDescription": { "type": "string" }, "gltUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gltReportSequence": { "type": "integer", "format": "int32" }, "gltRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLCategoryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLCategoryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLChartDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLChartDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLChartDto": { "required": [ "glcAccountType", "glcGlChartID", "glcDescription", "glcGlCategoryID", "glcNormalBalance" ], "type": "object", "properties": { "glcAccountType": { "type": "integer", "format": "int32" }, "glcCashFlowCategory": { "type": "integer", "format": "int32" }, "glcGlChartID": { "type": "string" }, "glcCogsAccountType": { "type": "integer", "format": "int32" }, "glcCreatedBy": { "type": "string" }, "glcCreatedDate": { "type": "string", "format": "date-time" }, "glcDescription": { "type": "string" }, "glcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glcGlCategoryID": { "type": "string" }, "glcCashEquivalents": { "type": "boolean" }, "glcParentAccount": { "type": "boolean" }, "glcNormalBalance": { "type": "integer", "format": "int32" }, "glcParentDescription": { "type": "string" }, "glcParentGlChartID": { "type": "string" }, "glcRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLChartDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLChartDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLDepartmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLDepartmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLDepartmentDto": { "required": [ "gldGlDepartmentID", "gldDescription" ], "type": "object", "properties": { "gldGlDepartmentID": { "type": "string" }, "gldCreatedBy": { "type": "string" }, "gldCreatedDate": { "type": "string", "format": "date-time" }, "gldDescription": { "type": "string" }, "gldUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gldRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLDepartmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLDepartmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLDivisionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLDivisionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLDivisionDto": { "required": [ "glvGlDivisionID", "glvDescription" ], "type": "object", "properties": { "glvGlDivisionID": { "type": "string" }, "glvCreatedBy": { "type": "string" }, "glvCreatedDate": { "type": "string", "format": "date-time" }, "glvDescription": { "type": "string" }, "glvUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glvRetainedEarningsAccountID": { "type": "string" }, "glvRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLDivisionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLDivisionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetAmountDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetAmountDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLFiscalYearBudgetAmountDto": { "required": [ "glbBudgetHeaderID", "glbBudgetLineID", "glbGlFiscalYearID", "glbGlFiscalYearPeriodID" ], "type": "object", "properties": { "glbBudgetAmount": { "minimum": 0, "type": "number", "format": "double" }, "glbBudgetHeaderID": { "type": "integer", "format": "int32" }, "glbBudgetLineID": { "type": "integer", "format": "int32" }, "glbCreatedBy": { "type": "string" }, "glbCreatedDate": { "type": "string", "format": "date-time" }, "glbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glbGlFiscalYearID": { "type": "integer", "format": "int32" }, "glbGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "glbRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLFiscalYearBudgetAmountDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetAmountDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetHeaderDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetHeaderDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLFiscalYearBudgetHeaderDto": { "required": [ "glkBudgetHeaderID", "glkGlAccountID", "glkGlFiscalYearID" ], "type": "object", "properties": { "glkAnnualAmount": { "minimum": 0, "type": "number", "format": "double" }, "glkBudgetHeaderID": { "type": "integer", "format": "int32" }, "glkCreatedBy": { "type": "string" }, "glkCreatedDate": { "type": "string", "format": "date-time" }, "glkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glkGlAccountID": { "type": "string" }, "glkGlFiscalYearID": { "type": "integer", "format": "int32" }, "glkRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLFiscalYearBudgetHeaderDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetHeaderDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearBudgetLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLFiscalYearBudgetLineDto": { "required": [ "glgBudgetHeaderID", "glgBudgetLineID", "glgGlFiscalYearID" ], "type": "object", "properties": { "glgAnnualAmount": { "minimum": 0, "type": "number", "format": "double" }, "glgBudgetHeaderID": { "type": "integer", "format": "int32" }, "glgBudgetLineID": { "type": "integer", "format": "int32" }, "glgCreatedBy": { "type": "string" }, "glgCreatedDate": { "type": "string", "format": "date-time" }, "glgUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glgGlFiscalYearID": { "type": "integer", "format": "int32" }, "glgRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPGLFiscalYearBudgetLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearBudgetLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearOpeningBalanceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearOpeningBalanceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPGLFiscalYearOpeningBalanceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearOpeningBalanceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodMovementDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearPeriodMovementDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPGLFiscalYearPeriodMovementDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearPeriodMovementDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearPeriodDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearPeriodDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLFiscalYearPeriodDto": { "required": [ "glfGlFiscalYearID", "glfGlFiscalYearPeriodID" ], "type": "object", "properties": { "glfCreatedBy": { "type": "string" }, "glfCreatedDate": { "type": "string", "format": "date-time" }, "glfEndDate": { "type": "string", "format": "date-time" }, "glfUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glfGlFiscalYearID": { "type": "integer", "format": "int32" }, "glfApClosed": { "type": "boolean" }, "glfArClosed": { "type": "boolean" }, "glfGlClosed": { "type": "boolean" }, "glfRowVersion": { "type": "integer", "format": "int64" }, "glfGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "glfStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPGLFiscalYearPeriodDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearPeriodDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLFiscalYearDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLFiscalYearDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLFiscalYearDto": { "required": [ "glzEndDate", "glzGlFiscalYearID", "glzStartDate" ], "type": "object", "properties": { "glzCreatedBy": { "type": "string" }, "glzCreatedDate": { "type": "string", "format": "date-time" }, "glzEndDate": { "type": "string", "format": "date-time" }, "glzUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glzRowVersion": { "type": "integer", "format": "int64" }, "glzGlFiscalYearID": { "type": "integer", "format": "int32" }, "glzStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPGLFiscalYearDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLFiscalYearDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLJournalLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLJournalLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLJournalLineDto": { "required": [ "gllDescription", "gllGlAccountID", "gllGlJournalID", "gllGlJournalLineID" ], "type": "object", "properties": { "gllArPaymentHeaderID": { "type": "integer", "format": "int32" }, "gllArPaymentSessionID": { "type": "integer", "format": "int32" }, "gllCreatedBy": { "type": "string" }, "gllCreatedDate": { "type": "string", "format": "date-time" }, "gllCreditAmount": { "minimum": 0, "type": "number", "format": "double" }, "gllDebitAmount": { "minimum": 0, "type": "number", "format": "double" }, "gllDescription": { "type": "string" }, "gllUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gllGlAccountID": { "type": "string" }, "gllGlFiscalYearID": { "type": "integer", "format": "int32" }, "gllGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "gllGlJournalID": { "type": "integer", "format": "int32" }, "gllPosted": { "type": "boolean" }, "gllJobAssemblyID": { "type": "integer", "format": "int32" }, "gllJobID": { "type": "string" }, "gllJobMaterialComponentID": { "type": "integer", "format": "int32" }, "gllJobMaterialID": { "type": "integer", "format": "int32" }, "gllJobOperationID": { "type": "integer", "format": "int32" }, "gllLocationID": { "type": "string" }, "gllOrganizationID": { "type": "string" }, "gllPartTransactionID": { "type": "integer", "format": "int32" }, "gllReference": { "type": "string" }, "gllRowVersion": { "type": "integer", "format": "int64" }, "gllGlJournalLineID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "gllSourceTableName": { "type": "string" }, "gllSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gllTaxableAmount": { "minimum": 0, "type": "number", "format": "double" }, "gllTaxCodeID": { "type": "string" }, "gllTransactionAmount": { "type": "number", "format": "double" }, "gllTransactionDate": { "type": "string", "format": "date-time" }, "gllTransactionType": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPGLJournalLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLJournalLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLJournalMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLJournalMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLJournalMemoDto": { "required": [ "glmGlJournalID", "glmMemoDate", "glmGlJournalMemoID", "glmShortDescription" ], "type": "object", "properties": { "glmCreatedBy": { "type": "string" }, "glmCreatedDate": { "type": "string", "format": "date-time" }, "glmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glmGlJournalID": { "type": "integer", "format": "int32" }, "glmClosed": { "type": "boolean" }, "glmLongDescriptionRtf": { "type": "string" }, "glmLongDescriptionText": { "type": "string" }, "glmMemoDate": { "type": "string", "format": "date-time" }, "glmRowVersion": { "type": "integer", "format": "int64" }, "glmGlJournalMemoID": { "type": "integer", "format": "int32" }, "glmShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPGLJournalMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLJournalMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPGLJournalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPGLJournalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPGLJournalDto": { "required": [ "glpDescription", "glpDetailSource", "glpGlFiscalYearID", "glpGlFiscalYearPeriodID", "glpGlJournalID", "glpSource", "glpTransactionDate" ], "type": "object", "properties": { "glpApInvoiceID": { "type": "string" }, "glpApPaymentHeaderID": { "type": "integer", "format": "int32" }, "glpApPaymentSessionID": { "type": "integer", "format": "int32" }, "glpArInvoiceID": { "type": "string" }, "glpArPaymentHeaderID": { "type": "integer", "format": "int32" }, "glpArPaymentSessionID": { "type": "integer", "format": "int32" }, "glpAssetAdjustmentID": { "type": "integer", "format": "int32" }, "glpAssetID": { "type": "string" }, "glpBankStatementID": { "type": "integer", "format": "int32" }, "glpCreatedBy": { "type": "string" }, "glpCreatedDate": { "type": "string", "format": "date-time" }, "glpDescription": { "type": "string" }, "glpDetailSource": { "type": "integer", "format": "int32" }, "glpDmrShipmentID": { "type": "string" }, "glpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glpGlFiscalYearID": { "type": "integer", "format": "int32" }, "glpGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "glpPosted": { "type": "boolean" }, "glpReversingEntry": { "type": "boolean" }, "glpJobAssemblyID": { "type": "integer", "format": "int32" }, "glpJobID": { "type": "string" }, "glpLandedCostID": { "type": "string" }, "glpLocationID": { "type": "string" }, "glpLongDescriptionRtf": { "type": "string" }, "glpLongDescriptionText": { "type": "string" }, "glpOrganizationID": { "type": "string" }, "glpPostedDate": { "type": "string", "format": "date-time" }, "glpReceiptID": { "type": "string" }, "glpReference": { "type": "string" }, "glpRmaReceiptID": { "type": "string" }, "glpRowVersion": { "type": "integer", "format": "int64" }, "glpGlJournalID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "glpShipmentID": { "type": "string" }, "glpSource": { "type": "integer", "format": "int32" }, "glpTimecardID": { "type": "integer", "format": "int32" }, "glpTotalCredits": { "minimum": 0, "type": "number", "format": "double" }, "glpTotalDebits": { "minimum": 0, "type": "number", "format": "double" }, "glpTransactionDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPGLJournalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPGLJournalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPaymentMethodDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPaymentMethodDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPaymentMethodDto": { "required": [ "xahPaymentMethodID", "xahDescription" ], "type": "object", "properties": { "xahArPaymentSessionRule": { "type": "integer", "format": "int32" }, "xahBankAccountID": { "type": "string" }, "xahPaymentMethodID": { "type": "string" }, "xahCreatedBy": { "type": "string" }, "xahCreatedDate": { "type": "string", "format": "date-time" }, "xahDescription": { "type": "string" }, "xahUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xahInactiveDate": { "type": "string", "format": "date-time" }, "xahInactive": { "type": "boolean" }, "xahDoNotOpenCashDrawer": { "type": "boolean" }, "xahPmAmex": { "type": "boolean" }, "xahPmCash": { "type": "boolean" }, "xahPmCheck": { "type": "boolean" }, "xahPmDiners": { "type": "boolean" }, "xahPmDiscover": { "type": "boolean" }, "xahPmEnroute": { "type": "boolean" }, "xahPmJAL": { "type": "boolean" }, "xahPmJCB": { "type": "boolean" }, "xahPmMasterCard": { "type": "boolean" }, "xahPmPurchaseOrder": { "type": "boolean" }, "xahPmStoreCredit": { "type": "boolean" }, "xahPmVisa": { "type": "boolean" }, "xahRefundPriority": { "type": "integer", "format": "int32" }, "xahRowVersion": { "type": "integer", "format": "int64" }, "xahSettlementTime": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPaymentMethodDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPaymentMethodDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPaymentTermDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPaymentTermDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPaymentTermDto": { "required": [ "xatCalculationType", "xatPaymentTermID", "xatDescription" ], "type": "object", "properties": { "xatCalculationDayOfMonth": { "type": "integer", "format": "int32" }, "xatCalculationType": { "type": "integer", "format": "int32" }, "xatPaymentTermID": { "type": "string" }, "xatCreatedBy": { "type": "string" }, "xatCreatedDate": { "type": "string", "format": "date-time" }, "xatDaysDue": { "type": "integer", "format": "int32" }, "xatDescription": { "type": "string" }, "xatDiscountDayOfMonth": { "type": "integer", "format": "int32" }, "xatDiscountDays": { "type": "integer", "format": "int32" }, "xatDiscountPercent": { "minimum": 0, "type": "number", "format": "double" }, "xatUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xatGracePeriod": { "type": "integer", "format": "int32" }, "xatImmediatePaymentRequired": { "type": "boolean" }, "xatRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPaymentTermDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPaymentTermDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProjectedPaymentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProjectedPaymentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProjectedPaymentDto": { "required": [ "gloDescription", "gloPaymentDate", "gloPaymentType", "gloProjectedPaymentID" ], "type": "object", "properties": { "gloAmount": { "minimum": 0, "type": "number", "format": "double" }, "gloClosedDate": { "type": "string", "format": "date-time" }, "gloCreatedBy": { "type": "string" }, "gloCreatedDate": { "type": "string", "format": "date-time" }, "gloDescription": { "type": "string" }, "gloUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gloIgnoreAfterDate": { "type": "string", "format": "date-time" }, "gloClosed": { "type": "boolean" }, "gloOrganizationID": { "type": "string" }, "gloPaymentDate": { "type": "string", "format": "date-time" }, "gloPaymentType": { "type": "integer", "format": "int32" }, "gloPlantDepartmentID": { "type": "string" }, "gloPlantID": { "type": "string" }, "gloRowVersion": { "type": "integer", "format": "int64" }, "gloProjectedPaymentID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProjectedPaymentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProjectedPaymentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPChangeLogDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPChangeLogDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPChangeLogDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPChangeLogDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCurrencyRateLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCurrencyRateLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCurrencyRateLineDto": { "required": [ "mclCurrencyRateID", "mclEffectiveDate", "mclExchangeRate", "mclCurrencyRateLineID" ], "type": "object", "properties": { "mclCreatedBy": { "type": "string" }, "mclCreatedDate": { "type": "string", "format": "date-time" }, "mclCurrencyRateID": { "type": "string" }, "mclEffectiveDate": { "type": "string", "format": "date-time" }, "mclUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mclExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "mclReference": { "type": "string" }, "mclRowVersion": { "type": "integer", "format": "int64" }, "mclCurrencyRateLineID": { "maximum": 9999999, "minimum": 0, "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPCurrencyRateLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCurrencyRateLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCurrencyRateDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCurrencyRateDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCurrencyRateDto": { "required": [ "mcpCurrencyRateID", "mcpDescription", "mcpSymbol" ], "type": "object", "properties": { "mcpApGlAccountID": { "type": "string" }, "mcpArGlAccountID": { "type": "string" }, "mcpCurrencyRateID": { "type": "string" }, "mcpCreatedBy": { "type": "string" }, "mcpCreatedDate": { "type": "string", "format": "date-time" }, "mcpDescription": { "type": "string" }, "mcpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mcpExchangeGainGlAccountID": { "type": "string" }, "mcpExchangeLossGlAccountID": { "type": "string" }, "mcpRowVersion": { "type": "integer", "format": "int64" }, "mcpSymbol": { "type": "string" }, "mcpUnrealisedExGainGlAccountID": { "type": "string" }, "mcpUnrealisedExLossGlAccountID": { "type": "string" } } }, "ERPResponseMessageDto[ERPCurrencyRateDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCurrencyRateDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDatasetPropertyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDatasetPropertyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPDatasetPropertyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDatasetPropertyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFinancialPropertyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFinancialPropertyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPFinancialPropertyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFinancialPropertyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPNextIDDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPNextIDDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPNextIDDto": { "type": "object", "properties": { "xanAutoIncrement": { "type": "integer", "format": "int32" }, "xanCreatedBy": { "type": "string" }, "xanCreatedDate": { "type": "string", "format": "date-time" }, "xanDatasets": { "type": "string" }, "xanUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xanIncrementAmount": { "type": "integer", "format": "int32" }, "xanLogChanges": { "type": "integer", "format": "int32" }, "xanNextID": { "type": "string" }, "xanNumericOnly": { "type": "integer", "format": "int32" }, "xanRowVersion": { "type": "integer", "format": "int64" }, "xanTable": { "type": "string" } } }, "ERPResponseMessageDto[ERPNextIDDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPNextIDDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductionPropertyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductionPropertyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProductionPropertyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductionPropertyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPReasonPlantDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPReasonPlantDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPReasonPlantDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPReasonPlantDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPReasonDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPReasonDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPReasonDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPReasonDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRecentActivitiesLogDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRecentActivitiesLogDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPRecentActivitiesLogDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRecentActivitiesLogDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShippingPropertyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShippingPropertyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPShippingPropertyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShippingPropertyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPStandardMessageDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPStandardMessageDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPStandardMessageDto": { "required": [ "xamStandardMessageID", "xamLongDescriptionText", "xamMessageType", "xamShortDescription" ], "type": "object", "properties": { "xamStandardMessageID": { "type": "string" }, "xamCreatedBy": { "type": "string" }, "xamCreatedDate": { "type": "string", "format": "date-time" }, "xamUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xamInactiveDate": { "type": "string", "format": "date-time" }, "xamInactive": { "type": "boolean" }, "xamLongDescriptionRtf": { "type": "string" }, "xamLongDescriptionText": { "type": "string" }, "xamMessageType": { "type": "integer", "format": "int32" }, "xamRowVersion": { "type": "integer", "format": "int64" }, "xamShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPStandardMessageDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPStandardMessageDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPTaxCodeLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPTaxCodeLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPTaxCodeLineDto": { "required": [ "xabEffectiveDate", "xabTaxCodeLineID", "xabTaxCodeID" ], "type": "object", "properties": { "xabCreatedBy": { "type": "string" }, "xabCreatedDate": { "type": "string", "format": "date-time" }, "xabEffectiveDate": { "type": "string", "format": "date-time" }, "xabUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xabRowVersion": { "type": "integer", "format": "int64" }, "xabTaxCodeLineID": { "maximum": 9999999, "minimum": 0, "type": "integer", "format": "int32" }, "xabTaxCodeID": { "type": "string" }, "xabTaxRate": { "minimum": 0, "type": "number", "format": "double" }, "xabTaxRateNotesRTF": { "type": "string" }, "xabTaxRateNotesText": { "type": "string" } } }, "ERPResponseMessageDto[ERPTaxCodeLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPTaxCodeLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPTaxCodePlantDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPTaxCodePlantDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPTaxCodePlantDto": { "type": "object", "properties": { "xtpAccrualGlAccountID": { "type": "string" }, "xtpCreatedBy": { "type": "string" }, "xtpCreatedDate": { "type": "string", "format": "date-time" }, "xtpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xtpPlantID": { "type": "string" }, "xtpRowVersion": { "type": "integer", "format": "int64" }, "xtpTaxCodeID": { "type": "string" } } }, "ERPResponseMessageDto[ERPTaxCodePlantDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPTaxCodePlantDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPTaxCodeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPTaxCodeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPTaxCodeDto": { "required": [ "xaxTaxCodeID", "xaxDescription", "xaxTaxOption", "xaxTaxType" ], "type": "object", "properties": { "xaxAccrualGlAccountID": { "type": "string" }, "xaxTaxCodeID": { "type": "string" }, "xaxCreatedBy": { "type": "string" }, "xaxCreatedDate": { "type": "string", "format": "date-time" }, "xaxDescription": { "type": "string" }, "xaxUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xaxInactiveDate": { "type": "string", "format": "date-time" }, "xaxInactive": { "type": "boolean" }, "xaxIncludePrimaryTax": { "type": "boolean" }, "xaxRowVersion": { "type": "integer", "format": "int64" }, "xaxTaxOption": { "type": "string" }, "xaxTaxType": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPTaxCodeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPTaxCodeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPTopActivitiesLogDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPTopActivitiesLogDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPTopActivitiesLogDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPTopActivitiesLogDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[String]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "string" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCycleCodeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCycleCodeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCycleCodeDto": { "required": [ "imdCycleCodeID", "imdDescription" ], "type": "object", "properties": { "imdCycleCodeID": { "type": "string" }, "imdCreatedBy": { "type": "string" }, "imdCreatedDate": { "type": "string", "format": "date-time" }, "imdDescription": { "type": "string" }, "imdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imdRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPCycleCodeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCycleCodeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPInventoryCountLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPInventoryCountLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPInventoryCountLineDto": { "required": [ "imqInventoryCountID", "imqPartBinID", "imqPartID", "imqPartWarehouseLocationID", "imqInventoryCountLineID" ], "type": "object", "properties": { "imqBinDescription": { "type": "string" }, "imqCountedBy": { "type": "string" }, "imqCountedDate": { "type": "string", "format": "date-time" }, "imqCreatedBy": { "type": "string" }, "imqCreatedDate": { "type": "string", "format": "date-time" }, "imqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imqFinalCount": { "minimum": 0, "type": "number", "format": "double" }, "imqInventoryCountID": { "type": "integer", "format": "int32" }, "imqPartBinID": { "type": "string" }, "imqPartClassID": { "type": "string" }, "imqPartID": { "type": "string" }, "imqPartRevisionID": { "type": "string" }, "imqPartShortDescription": { "type": "string" }, "imqPartWarehouseLocationID": { "type": "string" }, "imqQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "imqRowVersion": { "type": "integer", "format": "int64" }, "imqInventoryCountLineID": { "maximum": 9999999, "minimum": 0, "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPInventoryCountLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPInventoryCountLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPInventoryCountDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPInventoryCountDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPInventoryCountDto": { "required": [ "imnInventoryCountID", "imnStatus" ], "type": "object", "properties": { "imnCreatedBy": { "type": "string" }, "imnCreatedDate": { "type": "string", "format": "date-time" }, "imnCycleCodeID": { "type": "string" }, "imnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imnGeneratedDate": { "type": "string", "format": "date-time" }, "imnExcludeInactivePartBins": { "type": "boolean" }, "imnIncludeBlankPartClass": { "type": "boolean" }, "imnIncludeBlankPartGroup": { "type": "boolean" }, "imnPostedToInventory": { "type": "boolean" }, "imnRecordsGenerated": { "type": "boolean" }, "imnNumberofRecordsGenerated": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "imnPartBinIDs": { "type": "string" }, "imnPartClassIDs": { "type": "string" }, "imnPartGroupIDs": { "type": "string" }, "imnPartWarehouseIDs": { "type": "string" }, "imnPostedDate": { "type": "string", "format": "date-time" }, "imnRowVersion": { "type": "integer", "format": "int64" }, "imnInventoryCountID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "imnStatus": { "type": "integer", "format": "int32" }, "imnSupplierOrganizationIDs": { "type": "string" } } }, "ERPResponseMessageDto[ERPInventoryCountDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPInventoryCountDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLandedCostCategoryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLandedCostCategoryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPLandedCostCategoryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLandedCostCategoryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLandedCostChargeDetailDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLandedCostChargeDetailDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLandedCostChargeDetailDto": { "required": [ "rmiLandedCostChargeID", "rmiLandedCostID", "rmiLandedCostChargeDetailID" ], "type": "object", "properties": { "rmiCreatedBy": { "type": "string" }, "rmiCreatedDate": { "type": "string", "format": "date-time" }, "rmiUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmiEstTotalCost": { "minimum": 0, "type": "number", "format": "double" }, "rmiEstTotalCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmiLandedCostChargeID": { "type": "integer", "format": "int32" }, "rmiLandedCostID": { "type": "string" }, "rmiPurchaseOrderID": { "type": "string" }, "rmiPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "rmiRowVersion": { "type": "integer", "format": "int64" }, "rmiLandedCostChargeDetailID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "rmiTotalCost": { "minimum": 0, "type": "number", "format": "double" }, "rmiTotalCostForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPLandedCostChargeDetailDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLandedCostChargeDetailDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLandedCostChargeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLandedCostChargeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLandedCostChargeDto": { "required": [ "rmhDescription", "rmhLandedCostCategoryID", "rmhLandedCostID", "rmhLandedCostMethod", "rmhLandedCostChargeID", "rmhSupplierOrganizationID" ], "type": "object", "properties": { "rmhApInvoiceID": { "type": "string" }, "rmhApInvoiceLineID": { "type": "integer", "format": "int32" }, "rmhCreatedBy": { "type": "string" }, "rmhCreatedDate": { "type": "string", "format": "date-time" }, "rmhCurrencyRateID": { "type": "string" }, "rmhDescription": { "type": "string" }, "rmhUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmhEstExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "rmhEstTotalCost": { "minimum": 0, "type": "number", "format": "double" }, "rmhEstTotalCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmhExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "rmhCustomRate": { "type": "boolean" }, "rmhInTransitJournalsCreated": { "type": "boolean" }, "rmhInvoicedComplete": { "type": "boolean" }, "rmhReversed": { "type": "boolean" }, "rmhLandedCostCategoryID": { "type": "string" }, "rmhLandedCostID": { "type": "string" }, "rmhLandedCostMethod": { "type": "integer", "format": "int32" }, "rmhReverseLandedCostChargeID": { "type": "integer", "format": "int32" }, "rmhReverseLandedCostID": { "type": "string" }, "rmhRowVersion": { "type": "integer", "format": "int64" }, "rmhLandedCostChargeID": { "type": "integer", "format": "int32" }, "rmhSupplierContactID": { "type": "string" }, "rmhSupplierLocationID": { "type": "string" }, "rmhSupplierOrganizationID": { "type": "string" }, "rmhTotalCost": { "minimum": 0, "type": "number", "format": "double" }, "rmhTotalCostForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPLandedCostChargeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLandedCostChargeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLandedCostDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLandedCostDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLandedCostDto": { "required": [ "rmcLandedCostID", "rmcGlFiscalYearID", "rmcGlFiscalYearPeriodID", "rmcLandedCostDate" ], "type": "object", "properties": { "rmcCarrierName": { "type": "string" }, "rmcClosedDate": { "type": "string", "format": "date-time" }, "rmcLandedCostID": { "type": "string" }, "rmcConsigneeContactID": { "type": "string" }, "rmcConsigneeLocationID": { "type": "string" }, "rmcConsigneeOrganizationID": { "type": "string" }, "rmcCreatedBy": { "type": "string" }, "rmcCreatedDate": { "type": "string", "format": "date-time" }, "rmcDischargePoint": { "type": "string" }, "rmcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmcGlFiscalYearID": { "type": "integer", "format": "int32" }, "rmcGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "rmcChargesComplete": { "type": "boolean" }, "rmcChargesJournalsCreated": { "type": "boolean" }, "rmcClosed": { "type": "boolean" }, "rmcPoInTransitComplete": { "type": "boolean" }, "rmcPoInTransitJournalsCreated": { "type": "boolean" }, "rmcPostedToGl": { "type": "boolean" }, "rmcReversalEntry": { "type": "boolean" }, "rmcReversed": { "type": "boolean" }, "rmcLandedCostChargesTotal": { "minimum": 0, "type": "number", "format": "double" }, "rmcLandedCostDate": { "type": "string", "format": "date-time" }, "rmcLandedCostPurchasesTotal": { "minimum": 0, "type": "number", "format": "double" }, "rmcLandedCostReceiptsTotal": { "minimum": 0, "type": "number", "format": "double" }, "rmcLandedCostTotal": { "minimum": 0, "type": "number", "format": "double" }, "rmcLoadingPoint": { "type": "string" }, "rmcLongDescriptionRtf": { "type": "string" }, "rmcLongDescriptionText": { "type": "string" }, "rmcPlantDepartmentID": { "type": "string" }, "rmcPlantID": { "type": "string" }, "rmcPostedDate": { "type": "string", "format": "date-time" }, "rmcReverseLandedCostID": { "type": "string" }, "rmcRowVersion": { "type": "integer", "format": "int64" }, "rmcShipContactID": { "type": "string" }, "rmcShipLocationID": { "type": "string" }, "rmcShipOrganizationID": { "type": "string" }, "rmcTrackingNumber": { "type": "string" } } }, "ERPResponseMessageDto[ERPLandedCostDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLandedCostDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLotNumberDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLotNumberDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLotNumberDto": { "required": [ "ablAddedByUserID", "ablAddedDate", "ablLotNumberID" ], "type": "object", "properties": { "ablAddedByUserID": { "type": "string" }, "ablAddedDate": { "type": "string", "format": "date-time" }, "ablLotNumberID": { "type": "string" }, "ablCreatedBy": { "type": "string" }, "ablCreatedDate": { "type": "string", "format": "date-time" }, "ablUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ablExpirationDate": { "type": "string", "format": "date-time" }, "ablInactiveDate": { "type": "string", "format": "date-time" }, "ablInactive": { "type": "boolean" }, "ablPartID": { "type": "string" }, "ablPartRevisionID": { "type": "string" }, "ablRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPLotNumberDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLotNumberDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLotNumberStatusDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLotNumberStatusDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLotNumberStatusDto": { "required": [ "absLotNumberID" ], "type": "object", "properties": { "absCreatedBy": { "type": "string" }, "absCreatedDate": { "type": "string", "format": "date-time" }, "absUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "absLotNumberID": { "type": "string" }, "absPartBinID": { "type": "string" }, "absPartID": { "type": "string" }, "absPartRevisionID": { "type": "string" }, "absPartWarehouseLocationID": { "type": "string" }, "absQuantity": { "minimum": 0, "type": "number", "format": "double" }, "absRowVersion": { "type": "integer", "format": "int64" }, "absStatus": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPLotNumberStatusDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLotNumberStatusDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPLotNumberTransactionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPLotNumberTransactionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPLotNumberTransactionDto": { "required": [ "abtLotNumberID", "abtOldTransactionType", "abtLotNumberTransactionID", "abtTransactionDate", "abtTransactionType" ], "type": "object", "properties": { "abtCreatedBy": { "type": "string" }, "abtCreatedDate": { "type": "string", "format": "date-time" }, "abtDmrShipmentID": { "type": "string" }, "abtDmrShipmentLineID": { "type": "integer", "format": "int32" }, "abtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "abtInspectionID": { "type": "string" }, "abtInspectionLineID": { "type": "integer", "format": "int32" }, "abtInventoryCountID": { "type": "integer", "format": "int32" }, "abtInventoryCountLineID": { "type": "integer", "format": "int32" }, "abtInProgress": { "type": "boolean" }, "abtInspect": { "type": "boolean" }, "abtNegativeTransaction": { "type": "boolean" }, "abtNonInventoryTransaction": { "type": "boolean" }, "abtJobAssemblyID": { "type": "integer", "format": "int32" }, "abtJobID": { "type": "string" }, "abtJobMaterialComponentID": { "type": "integer", "format": "int32" }, "abtJobMaterialID": { "type": "integer", "format": "int32" }, "abtLandedCostID": { "type": "string" }, "abtLotNumberID": { "type": "string" }, "abtOldTransactionType": { "type": "integer", "format": "int32" }, "abtPartBinID": { "type": "string" }, "abtPartID": { "type": "string" }, "abtPartRevisionID": { "type": "string" }, "abtPartTransactionID": { "type": "integer", "format": "int32" }, "abtPartWarehouseLocationID": { "type": "string" }, "abtQuantity": { "minimum": 0, "type": "number", "format": "double" }, "abtQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "abtReceiptID": { "type": "string" }, "abtReceiptLineID": { "type": "integer", "format": "int32" }, "abtRmaReceiptID": { "type": "string" }, "abtRmaReceiptLineID": { "type": "integer", "format": "int32" }, "abtRowVersion": { "type": "integer", "format": "int64" }, "abtLotNumberTransactionID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "abtShipmentID": { "type": "string" }, "abtShipmentLineID": { "type": "integer", "format": "int32" }, "abtStatus": { "type": "integer", "format": "int32" }, "abtTableName": { "type": "string" }, "abtTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "abtTransactionDate": { "type": "string", "format": "date-time" }, "abtTransactionType": { "type": "integer", "format": "int32" }, "abtWarehouseReceiptID": { "type": "string" }, "abtWarehouseReceiptLineID": { "type": "integer", "format": "int32" }, "abtWarehouseTransferID": { "type": "string" }, "abtWarehouseTransferLineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPLotNumberTransactionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPLotNumberTransactionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMaterialIssueComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMaterialIssueComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMaterialIssueComponentDto": { "required": [ "inkMaterialIssueID", "inkMaterialIssueLineID", "inkPartBinID", "inkPartID", "inkPartWarehouseLocationID", "inkMaterialIssueComponentID" ], "type": "object", "properties": { "inkAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkCreatedBy": { "type": "string" }, "inkCreatedDate": { "type": "string", "format": "date-time" }, "inkDescription": { "type": "string" }, "inkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "inkInvIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkInvParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkInvParentQuantityScrap": { "minimum": 0, "type": "number", "format": "double" }, "inkInvScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkPosted": { "type": "boolean" }, "inkReceivedComplete": { "type": "boolean" }, "inkReversed": { "type": "boolean" }, "inkJobAssemblyID": { "type": "integer", "format": "int32" }, "inkJobID": { "type": "string" }, "inkJobMaterialComponentID": { "type": "integer", "format": "int32" }, "inkJobMaterialID": { "type": "integer", "format": "int32" }, "inkJobMatIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatParentQuantityScrap": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatParentReturnQty": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatParentReturnQtyScrap": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatReturnIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatReturnScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkJobMatScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inkMaterialIssueID": { "type": "string" }, "inkMaterialIssueLineID": { "type": "integer", "format": "int32" }, "inkPartBinID": { "type": "string" }, "inkPartID": { "type": "string" }, "inkPartRevisionID": { "type": "string" }, "inkPartWarehouseLocationID": { "type": "string" }, "inkQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "inkReverseMaterialIssueCompID": { "type": "integer", "format": "int32" }, "inkReverseMaterialIssueID": { "type": "string" }, "inkReverseMaterialIssueLineID": { "type": "integer", "format": "int32" }, "inkRowVersion": { "type": "integer", "format": "int64" }, "inkMaterialIssueComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "inkUnitOfMeasure": { "type": "string" }, "inkWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPMaterialIssueComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMaterialIssueComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMaterialIssueLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMaterialIssueLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMaterialIssueLineDto": { "required": [ "injIssueType", "injMaterialIssueID", "injPartBinID", "injPartID", "injPartWarehouseLocationID", "injMaterialIssueLineID" ], "type": "object", "properties": { "injCreatedBy": { "type": "string" }, "injCreatedDate": { "type": "string", "format": "date-time" }, "injUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "injEstimatedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injHeatLot": { "type": "string" }, "injInvIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injInvScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injCreateJobSeq": { "type": "boolean" }, "injIssueComplete": { "type": "boolean" }, "injKitPart": { "type": "boolean" }, "injPosted": { "type": "boolean" }, "injReversed": { "type": "boolean" }, "injIssueType": { "type": "integer", "format": "int32" }, "injJobAsmIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobAsmScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobAssemblyID": { "type": "integer", "format": "int32" }, "injJobID": { "type": "string" }, "injJobMaterialID": { "type": "integer", "format": "int32" }, "injJobMatIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobMatReturnIssueQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobMatReturnScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobMatScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "injJobType": { "type": "integer", "format": "int32" }, "injLongDescriptionRtf": { "type": "string" }, "injLongDescriptionText": { "type": "string" }, "injMaterialIssueID": { "type": "string" }, "injMiscIssueReasonID": { "type": "string" }, "injPartBinID": { "type": "string" }, "injPartID": { "type": "string" }, "injPartRevisionID": { "type": "string" }, "injPartWarehouseLocationID": { "type": "string" }, "injPlantID": { "type": "string" }, "injProjectAreaID": { "type": "string" }, "injProjectID": { "type": "string" }, "injQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "injQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "injReference": { "type": "string" }, "injReverseMaterialIssueID": { "type": "string" }, "injReverseMaterialIssueLineID": { "type": "integer", "format": "int32" }, "injRowVersion": { "type": "integer", "format": "int64" }, "injMaterialIssueLineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPMaterialIssueLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMaterialIssueLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMaterialIssueDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMaterialIssueDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMaterialIssueDto": { "required": [ "iniMaterialIssueID", "iniMaterialIssueDate" ], "type": "object", "properties": { "iniMaterialIssueID": { "type": "string" }, "iniCreatedBy": { "type": "string" }, "iniCreatedDate": { "type": "string", "format": "date-time" }, "iniUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "iniPosted": { "type": "boolean" }, "iniReversalEntry": { "type": "boolean" }, "iniReversed": { "type": "boolean" }, "iniMaterialIssueDate": { "type": "string", "format": "date-time" }, "iniPostedDate": { "type": "string", "format": "date-time" }, "iniRowVersion": { "type": "integer", "format": "int64" }, "iniSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" } } }, "ERPResponseMessageDto[ERPMaterialIssueDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMaterialIssueDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMfgReceiptComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMfgReceiptComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMfgReceiptComponentDto": { "required": [ "rmnPartBinID", "rmnPartID", "rmnPartWarehouseLocationID", "rmnMfgReceiptComponentID" ], "type": "object", "properties": { "rmnAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmnCreatedBy": { "type": "string" }, "rmnCreatedDate": { "type": "string", "format": "date-time" }, "rmnDescription": { "type": "string" }, "rmnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmnExtendedCost": { "minimum": 0, "type": "number", "format": "double" }, "rmnInvParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmnInvReceiptQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmnPosted": { "type": "boolean" }, "rmnReceivedComplete": { "type": "boolean" }, "rmnReversed": { "type": "boolean" }, "rmnJobAssemblyID": { "type": "integer", "format": "int32" }, "rmnJobID": { "type": "string" }, "rmnJobMaterialComponentID": { "type": "integer", "format": "int32" }, "rmnJobMaterialID": { "type": "integer", "format": "int32" }, "rmnJobMatParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmnJobMatReceiptQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmnMfgReceiptID": { "type": "string" }, "rmnPartBinID": { "type": "string" }, "rmnPartID": { "type": "string" }, "rmnPartRevisionID": { "type": "string" }, "rmnPartWarehouseLocationID": { "type": "string" }, "rmnQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "rmnReverseMfgReceiptCompID": { "type": "integer", "format": "int32" }, "rmnReverseMfgReceiptID": { "type": "string" }, "rmnRowVersion": { "type": "integer", "format": "int64" }, "rmnMfgReceiptComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "rmnUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmnUnitOfMeasure": { "type": "string" }, "rmnWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPMfgReceiptComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMfgReceiptComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMfgReceiptDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMfgReceiptDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMfgReceiptDto": { "required": [ "rmmMfgCostType", "rmmPartBinID", "rmmPartID", "rmmPartWarehouseLocationID", "rmmReceiptDate", "rmmReceiptType" ], "type": "object", "properties": { "rmmMfgReceiptID": { "type": "string" }, "rmmCreatedBy": { "type": "string" }, "rmmCreatedDate": { "type": "string", "format": "date-time" }, "rmmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmmEstimatedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "rmmHeatLot": { "type": "string" }, "rmmImCostingMethod": { "type": "integer", "format": "int32" }, "rmmInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmInventoryQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmmInventoryUnitOfMeasure": { "type": "string" }, "rmmCreateJobSeq": { "type": "boolean" }, "rmmInInspection": { "type": "boolean" }, "rmmInspectionComplete": { "type": "boolean" }, "rmmKitPart": { "type": "boolean" }, "rmmNotUpdateJobQtyComplete": { "type": "boolean" }, "rmmPoLineReceivedComplete": { "type": "boolean" }, "rmmPosted": { "type": "boolean" }, "rmmProductionComplete": { "type": "boolean" }, "rmmReceivedComplete": { "type": "boolean" }, "rmmRequiresInspection": { "type": "boolean" }, "rmmReversalEntry": { "type": "boolean" }, "rmmReversed": { "type": "boolean" }, "rmmJobAsmQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmmJobAssemblyID": { "type": "integer", "format": "int32" }, "rmmJobID": { "type": "string" }, "rmmJobMaterialID": { "type": "integer", "format": "int32" }, "rmmJobMatQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmmJobOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmJobOperationID": { "type": "integer", "format": "int32" }, "rmmJobOprQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmmJobScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmJobType": { "type": "integer", "format": "int32" }, "rmmLongDescriptionRtf": { "type": "string" }, "rmmLongDescriptionText": { "type": "string" }, "rmmMfgCostType": { "type": "integer", "format": "int32" }, "rmmMiscInvQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmmPartBinID": { "type": "string" }, "rmmPartID": { "type": "string" }, "rmmPartRevisionID": { "type": "string" }, "rmmPartWarehouseLocationID": { "type": "string" }, "rmmPlantDepartmentID": { "type": "string" }, "rmmPlantID": { "type": "string" }, "rmmPoOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmPostedDate": { "type": "string", "format": "date-time" }, "rmmProductionQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmProjectAreaID": { "type": "string" }, "rmmProjectID": { "type": "string" }, "rmmPurchaseLocationID": { "type": "string" }, "rmmPurchaseOrderID": { "type": "string" }, "rmmPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "rmmPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmPurchaseQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmmPurchaseUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmmPurchaseUnitOfMeasure": { "type": "string" }, "rmmQuantityCompleted": { "minimum": 0, "type": "number", "format": "double" }, "rmmQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "rmmQuantityReceivedToInventory": { "minimum": 0, "type": "number", "format": "double" }, "rmmQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "rmmReceiptDate": { "type": "string", "format": "date-time" }, "rmmReceiptType": { "type": "integer", "format": "int32" }, "rmmReference": { "type": "string" }, "rmmReverseMfgReceiptID": { "type": "string" }, "rmmRowVersion": { "type": "integer", "format": "int64" }, "rmmScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmmSetupCharge": { "minimum": 0, "type": "number", "format": "double" }, "rmmSupplierOrganizationID": { "type": "string" }, "rmmTotalComponentCosts": { "minimum": 0, "type": "number", "format": "double" }, "rmmTotalUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmmUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "rmmUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "rmmUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "rmmUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPMfgReceiptDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMfgReceiptDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartAlternateDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartAlternateDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartAlternateDto": { "required": [ "imeAlternatePartID", "imePartID" ], "type": "object", "properties": { "imeAlternatePartID": { "type": "string" }, "imeAlternatePartRevisionID": { "type": "string" }, "imeComment": { "type": "string" }, "imeCreatedBy": { "type": "string" }, "imeCreatedDate": { "type": "string", "format": "date-time" }, "imeUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imePartID": { "type": "string" }, "imePartRevisionID": { "type": "string" }, "imeRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPartAlternateDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartAlternateDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartAssemblyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartAssemblyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartAssemblyDto": { "required": [ "imaLevel", "imaMethodID", "imaPartID", "imaPartShortDescription", "imaQuantityPerParent" ], "type": "object", "properties": { "imaAssemblyOverlap": { "type": "integer", "format": "int32" }, "imaCreatedBy": { "type": "string" }, "imaCreatedDate": { "type": "string", "format": "date-time" }, "imaDocuments": { "type": "string" }, "imaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imaPullAllFromStock": { "type": "boolean" }, "imaUseMethod": { "type": "boolean" }, "imaLevel": { "type": "integer", "format": "int32" }, "imaMethodAssemblyID": { "type": "integer", "format": "int32" }, "imaMethodID": { "type": "string" }, "imaMethodRevisionID": { "type": "string" }, "imaOverlapDestinationLink": { "type": "integer", "format": "int32" }, "imaOverlapOffsetTime": { "minimum": 0, "type": "number", "format": "double" }, "imaOverlapOperationID": { "type": "integer", "format": "int32" }, "imaOverlapSourceLink": { "type": "integer", "format": "int32" }, "imaOverlapSourceOperationID": { "type": "integer", "format": "int32" }, "imaOverlapType": { "type": "integer", "format": "int32" }, "imaParentAssemblyID": { "type": "integer", "format": "int32" }, "imaPartID": { "type": "string" }, "imaPartLongDescriptionRtf": { "type": "string" }, "imaPartLongDescriptionText": { "type": "string" }, "imaPartRevisionID": { "type": "string" }, "imaPartShortDescription": { "type": "string" }, "imaProductionNotesRTF": { "type": "string" }, "imaProductionNotesText": { "type": "string" }, "imaQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "imaRowVersion": { "type": "integer", "format": "int64" }, "imaSourceMethodID": { "type": "string" }, "imaSourceRevisionID": { "type": "string" }, "imaUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartAssemblyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartAssemblyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartBinDetailDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartBinDetailDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartBinDetailDto": { "required": [ "imgPartBinID", "imgPartID", "imgPartBinDetailID", "imgTransactionDate", "imgWarehouseID" ], "type": "object", "properties": { "imgCreatedBy": { "type": "string" }, "imgCreatedDate": { "type": "string", "format": "date-time" }, "imgUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imgOriginalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imgPartBinID": { "type": "string" }, "imgPartID": { "type": "string" }, "imgPartRevisionID": { "type": "string" }, "imgQuantityType": { "type": "integer", "format": "int32" }, "imgRemainingQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imgRowVersion": { "type": "integer", "format": "int64" }, "imgPartBinDetailID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "imgSourceTableName": { "type": "string" }, "imgSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imgTransactionDate": { "type": "string", "format": "date-time" }, "imgUnitDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "imgUnitFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "imgUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "imgUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "imgUnitMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "imgUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "imgUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "imgWarehouseID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartBinDetailDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartBinDetailDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartBinDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartBinDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartBinDto": { "required": [ "imbPartBinID", "imbConversionFactor", "imbPartID", "imbWarehouseID" ], "type": "object", "properties": { "imbBinQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "imbPartBinID": { "type": "string" }, "imbConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "imbCreatedBy": { "type": "string" }, "imbCreatedDate": { "type": "string", "format": "date-time" }, "imbDescription": { "type": "string" }, "imbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imbInactiveBinDate": { "type": "string", "format": "date-time" }, "imbInactiveBin": { "type": "boolean" }, "imbDefaultBin": { "type": "boolean" }, "imbPartID": { "type": "string" }, "imbPartRevisionID": { "type": "string" }, "imbQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "imbQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "imbQuantityOnOrderPurchases": { "minimum": 0, "type": "number", "format": "double" }, "imbQuantityOnOrderSales": { "minimum": 0, "type": "number", "format": "double" }, "imbQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "imbQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "imbQuantityToReturnJob": { "minimum": 0, "type": "number", "format": "double" }, "imbRowVersion": { "type": "integer", "format": "int64" }, "imbWarehouseID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartBinDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartBinDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartClassDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartClassDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartClassDto": { "required": [ "imcPartClassID", "imcDescription", "imcPickingMethod" ], "type": "object", "properties": { "imcPartClassID": { "type": "string" }, "imcCreatedBy": { "type": "string" }, "imcCreatedDate": { "type": "string", "format": "date-time" }, "imcDescription": { "type": "string" }, "imcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imcFdxHandlingCost": { "minimum": 0, "type": "number", "format": "double" }, "imcFdxPackageHeight": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "imcFdxPackageLength": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "imcFdxPackageWidth": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "imcFdxPackaging": { "type": "string" }, "imcFdxPackagingCost": { "minimum": 0, "type": "number", "format": "double" }, "imcFdxShipCostMarkupPct": { "minimum": 0, "type": "number", "format": "double" }, "imcInactiveDate": { "type": "string", "format": "date-time" }, "imcInventoryGlAccountID": { "type": "string" }, "imcInvInInspectionGlAccountID": { "type": "string" }, "imcInvInTransferGlAccountID": { "type": "string" }, "imcInvToReturnGlAccountID": { "type": "string" }, "imcInactive": { "type": "boolean" }, "imcFdxNonstandardContainer": { "type": "boolean" }, "imcFdxOneItemPerShipment": { "type": "boolean" }, "imcRequiresInspection": { "type": "boolean" }, "imcParentPartClassID": { "type": "string" }, "imcPartImageFileName": { "type": "string" }, "imcPickingMethod": { "type": "integer", "format": "int32" }, "imcReorderMethod": { "type": "integer", "format": "int32" }, "imcRowVersion": { "type": "integer", "format": "int64" }, "imcWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPartClassDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartClassDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartClassPlantDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartClassPlantDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPPartClassPlantDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartClassPlantDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartCrossReferenceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartCrossReferenceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartCrossReferenceDto": { "required": [ "imxLocationID", "imxOrganizationID", "imxPartID" ], "type": "object", "properties": { "imxConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "imxCreatedBy": { "type": "string" }, "imxCreatedDate": { "type": "string", "format": "date-time" }, "imxUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imxInactive": { "type": "boolean" }, "imxPurchased": { "type": "boolean" }, "imxSold": { "type": "boolean" }, "imxLeadTime": { "type": "integer", "format": "int32" }, "imxLocationID": { "type": "string" }, "imxLotSize": { "minimum": 0, "type": "number", "format": "double" }, "imxMinimumPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imxOrganizationID": { "type": "string" }, "imxOrgPartID": { "type": "string" }, "imxOrgPartShortDescription": { "type": "string" }, "imxPartID": { "type": "string" }, "imxPartRevisionID": { "type": "string" }, "imxPurchaseUnitOfMeasure": { "type": "string" }, "imxRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPartCrossReferenceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartCrossReferenceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartForecastLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartForecastLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartForecastLineDto": { "type": "object", "properties": { "inlActualBalance": { "minimum": 0, "type": "number", "format": "double" }, "inlActualQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inlCreatedBy": { "type": "string" }, "inlCreatedDate": { "type": "string", "format": "date-time" }, "inlEndDate": { "type": "string", "format": "date-time" }, "inlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "inlForecastBalance": { "minimum": 0, "type": "number", "format": "double" }, "inlForecastQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inlIncludeInMRP": { "type": "boolean" }, "inlPartForecastPeriodID": { "type": "integer", "format": "int32" }, "inlPartForecastYearID": { "type": "integer", "format": "int32" }, "inlPartID": { "type": "string" }, "inlPartRevisionID": { "type": "string" }, "inlRemainingQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inlRemainingQuantityBalance": { "minimum": 0, "type": "number", "format": "double" }, "inlRowVersion": { "type": "integer", "format": "int64" }, "inlStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPPartForecastLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartForecastLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartForecastDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartForecastDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartForecastDto": { "required": [ "inpIntervalType", "inpPartForecastYearID", "inpPartID" ], "type": "object", "properties": { "inpAnnualQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inpCreatedBy": { "type": "string" }, "inpCreatedDate": { "type": "string", "format": "date-time" }, "inpEndDate": { "type": "string", "format": "date-time" }, "inpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "inpForecastMethod": { "type": "string" }, "inpForecastNumberOfYears": { "type": "integer", "format": "int32" }, "inpIntervalType": { "type": "string" }, "inpPartForecastYearID": { "type": "integer", "format": "int32" }, "inpPartID": { "type": "string" }, "inpPartRevisionID": { "type": "string" }, "inpRowVersion": { "type": "integer", "format": "int64" }, "inpStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPPartForecastDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartForecastDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartGroupPlantDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartGroupPlantDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPPartGroupPlantDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartGroupPlantDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartGroupDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartGroupDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartGroupDto": { "required": [ "imuPartGroupID", "imuCommissionType", "imuDescription" ], "type": "object", "properties": { "imuArDepositGlAccountID": { "type": "string" }, "imuAvalaraTaxCodeID": { "type": "string" }, "imuPartGroupID": { "type": "string" }, "imuCogsLaborGlAccountID": { "type": "string" }, "imuCogsMaterialGlAccountID": { "type": "string" }, "imuCogsOverheadGlAccountID": { "type": "string" }, "imuCogsSubcontractGlAccountID": { "type": "string" }, "imuCommissionRate": { "minimum": 0, "type": "number", "format": "double" }, "imuCommissionType": { "type": "integer", "format": "int32" }, "imuCreatedBy": { "type": "string" }, "imuCreatedDate": { "type": "string", "format": "date-time" }, "imuDescription": { "type": "string" }, "imuDiscountGlAccountID": { "type": "string" }, "imuUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imuInactiveDate": { "type": "string", "format": "date-time" }, "imuInactive": { "type": "boolean" }, "imuNextSerialNumberIDFormula": { "type": "string" }, "imuNextSerialNumberOption": { "type": "integer", "format": "int32" }, "imuNextSerialNumberValue": { "type": "string" }, "imuParentPartGroupID": { "type": "string" }, "imuPartImageFileName": { "type": "string" }, "imuQmLaborMarkup": { "minimum": 0, "type": "number", "format": "double" }, "imuQmMarkupOption": { "type": "integer", "format": "int32" }, "imuQmMaterialMarkup": { "minimum": 0, "type": "number", "format": "double" }, "imuQmOverHeadMarkup": { "minimum": 0, "type": "number", "format": "double" }, "imuQmPurchaseToOrderMarkup": { "minimum": 0, "type": "number", "format": "double" }, "imuQmQuoteMarkupType": { "type": "integer", "format": "int32" }, "imuQmQuotingMarkup": { "minimum": 0, "type": "number", "format": "double" }, "imuQmSubcontractMarkup": { "minimum": 0, "type": "number", "format": "double" }, "imuRowVersion": { "type": "integer", "format": "int64" }, "imuSalesGlAccountID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartGroupDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartGroupDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartMaterialDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartMaterialDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartMaterialDto": { "required": [ "immMethodID", "immMethodMaterialID", "immPartBinID", "immPartID", "immPartShortDescription", "immPartWarehouseLocationID" ], "type": "object", "properties": { "immCreatedBy": { "type": "string" }, "immCreatedDate": { "type": "string", "format": "date-time" }, "immDocuments": { "type": "string" }, "immUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "immEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "immBackflush": { "type": "boolean" }, "immManualPart": { "type": "boolean" }, "immUseDefaultWarehouseAndBin": { "type": "boolean" }, "immLeadTime": { "type": "integer", "format": "int32" }, "immMethodAssemblyID": { "type": "integer", "format": "int32" }, "immMethodID": { "type": "string" }, "immMethodMaterialID": { "type": "integer", "format": "int32" }, "immMethodRevisionID": { "type": "string" }, "immMinimumCharge": { "minimum": 0, "type": "number", "format": "double" }, "immPartBinID": { "type": "string" }, "immPartID": { "type": "string" }, "immPartLongDescriptionRtf": { "type": "string" }, "immPartLongDescriptionText": { "type": "string" }, "immPartRevisionID": { "type": "string" }, "immPartShortDescription": { "type": "string" }, "immPartWarehouseLocationID": { "type": "string" }, "immPurchaseLocationID": { "type": "string" }, "immQuantityPerAssembly": { "minimum": 0, "type": "number", "format": "double" }, "immRelatedPartOperationID": { "type": "integer", "format": "int32" }, "immRowVersion": { "type": "integer", "format": "int64" }, "immScrapPercent": { "minimum": 0, "type": "number", "format": "double" }, "immScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "immSupplierOrganizationID": { "type": "string" }, "immUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartMaterialDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartMaterialDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartMemoDto": { "required": [ "imkMemoDate", "imkPartID", "imkPartMemoID", "imkShortDescription" ], "type": "object", "properties": { "imkCreatedBy": { "type": "string" }, "imkCreatedDate": { "type": "string", "format": "date-time" }, "imkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imkLongDescriptionRtf": { "type": "string" }, "imkLongDescriptionText": { "type": "string" }, "imkMemoDate": { "type": "string", "format": "date-time" }, "imkPartID": { "type": "string" }, "imkPartRevisionID": { "type": "string" }, "imkRowVersion": { "type": "integer", "format": "int64" }, "imkPartMemoID": { "type": "integer", "format": "int32" }, "imkShortDescription": { "type": "string" }, "imkShowInApInvoices": { "type": "boolean" }, "imkShowInArInvoices": { "type": "boolean" }, "imkShowInCalls": { "type": "boolean" }, "imkShowInChangeRequests": { "type": "boolean" }, "imkShowInDmrClaims": { "type": "boolean" }, "imkShowInDmrShipments": { "type": "boolean" }, "imkShowInInspections": { "type": "boolean" }, "imkShowInJobAssemblies": { "type": "boolean" }, "imkShowInJobMaterials": { "type": "boolean" }, "imkShowInJobOperations": { "type": "boolean" }, "imkShowInJobs": { "type": "boolean" }, "imkShowInKnowledgebasePages": { "type": "boolean" }, "imkShowInLeads": { "type": "boolean" }, "imkShowInNonconformances": { "type": "boolean" }, "imkShowInPartAssemblies": { "type": "boolean" }, "imkShowInPartMaterials": { "type": "boolean" }, "imkShowInPartOperations": { "type": "boolean" }, "imkShowInPartRevisions": { "type": "boolean" }, "imkShowInPriceAndAvailability": { "type": "boolean" }, "imkShowInPurchaseOrders": { "type": "boolean" }, "imkShowInQuoteAssemblies": { "type": "boolean" }, "imkShowInQuoteLines": { "type": "boolean" }, "imkShowInQuoteMaterials": { "type": "boolean" }, "imkShowInQuoteOperations": { "type": "boolean" }, "imkShowInReceipts": { "type": "boolean" }, "imkShowInRfqs": { "type": "boolean" }, "imkShowInRmaClaims": { "type": "boolean" }, "imkShowInRmaReceipts": { "type": "boolean" }, "imkShowInSalesOrders": { "type": "boolean" }, "imkShowInServiceContracts": { "type": "boolean" }, "imkShowInShipments": { "type": "boolean" }, "imkShowInWarehouseReceipts": { "type": "boolean" }, "imkShowInWarehouseRequisitions": { "type": "boolean" }, "imkShowInWarehouseTransfers": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPPartMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartOperationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartOperationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartOperationDto": { "required": [ "imoMachineType", "imoMethodID", "imoMethodOperationID", "imoOperationType", "imoProcessID", "imoProcessShortDescription", "imoQuantityPerAssembly", "imoStandardFactor", "imoWorkCenterID" ], "type": "object", "properties": { "imoCreatedBy": { "type": "string" }, "imoCreatedDate": { "type": "string", "format": "date-time" }, "imoDocuments": { "type": "string" }, "imoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imoEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "imoInspectionType": { "type": "integer", "format": "int32" }, "imoMachinesToSchedule": { "type": "integer", "format": "int32" }, "imoMachineType": { "type": "integer", "format": "int32" }, "imoMethodAssemblyID": { "type": "integer", "format": "int32" }, "imoMethodID": { "type": "string" }, "imoMethodOperationID": { "type": "integer", "format": "int32" }, "imoMethodRevisionID": { "type": "string" }, "imoMinimumCharge": { "minimum": 0, "type": "number", "format": "double" }, "imoMoveTime": { "minimum": 0, "type": "number", "format": "double" }, "imoOperationType": { "type": "integer", "format": "int32" }, "imoOverlap": { "type": "integer", "format": "int32" }, "imoOverlapDestinationLink": { "type": "integer", "format": "int32" }, "imoOverlapOffsetTime": { "minimum": 0, "type": "number", "format": "double" }, "imoOverlapOperationID": { "type": "integer", "format": "int32" }, "imoOverlapSourceLink": { "type": "integer", "format": "int32" }, "imoPartID": { "type": "string" }, "imoPartRevisionID": { "type": "string" }, "imoPlantDepartmentID": { "type": "string" }, "imoPlantID": { "type": "string" }, "imoProcessID": { "type": "string" }, "imoProcessLongDescriptionRtf": { "type": "string" }, "imoProcessLongDescriptionText": { "type": "string" }, "imoProcessShortDescription": { "type": "string" }, "imoProductionStandard": { "minimum": 0, "type": "number", "format": "double" }, "imoPurchaseLocationID": { "type": "string" }, "imoQuantityBreak1": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak2": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak3": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak4": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak5": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak6": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak7": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak8": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityBreak9": { "minimum": 0, "type": "number", "format": "double" }, "imoQuantityPerAssembly": { "minimum": 0, "type": "number", "format": "double" }, "imoQueueTime": { "minimum": 0, "type": "number", "format": "double" }, "imoRowVersion": { "type": "integer", "format": "int64" }, "imoSetupCharge": { "minimum": 0, "type": "number", "format": "double" }, "imoSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "imoSfeMessageRTF": { "type": "string" }, "imoSfeMessageText": { "type": "string" }, "imoStandardFactor": { "type": "string" }, "imoSupplierOrganizationID": { "type": "string" }, "imoUnitCost1": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost2": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost3": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost4": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost5": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost6": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost7": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost8": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitCost9": { "minimum": 0, "type": "number", "format": "double" }, "imoUnitOfMeasure": { "type": "string" }, "imoWorkCenterID": { "type": "string" }, "imoWorkCenterMachineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPPartOperationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartOperationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartOrgReferenceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartOrgReferenceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartOrgReferenceDto": { "required": [ "imzOrganizationID", "imzPartID" ], "type": "object", "properties": { "imzConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "imzCreatedBy": { "type": "string" }, "imzCreatedDate": { "type": "string", "format": "date-time" }, "imzUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imzInactive": { "type": "boolean" }, "imzPurchased": { "type": "boolean" }, "imzSold": { "type": "boolean" }, "imzLeadTime": { "type": "integer", "format": "int32" }, "imzLotSize": { "minimum": 0, "type": "number", "format": "double" }, "imzMinimumPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imzOrganizationID": { "type": "string" }, "imzOrgPartID": { "type": "string" }, "imzOrgPartShortDescription": { "type": "string" }, "imzPartID": { "type": "string" }, "imzPartRevisionID": { "type": "string" }, "imzPurchaseUnitOfMeasure": { "type": "string" }, "imzRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPartOrgReferenceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartOrgReferenceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartPriceBreakDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartPriceBreakDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartPriceBreakDto": { "required": [ "imjPartPriceID", "imjPartPriceBreakID" ], "type": "object", "properties": { "imjCreatedBy": { "type": "string" }, "imjCreatedDate": { "type": "string", "format": "date-time" }, "imjDiscount": { "minimum": 0, "type": "number", "format": "double" }, "imjUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imjLeadTime": { "type": "integer", "format": "int32" }, "imjPartPriceID": { "type": "integer", "format": "int32" }, "imjProposedNewPrice": { "minimum": 0, "type": "number", "format": "double" }, "imjQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imjRowVersion": { "type": "integer", "format": "int64" }, "imjPartPriceBreakID": { "type": "integer", "format": "int32" }, "imjUnitPrice": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPartPriceBreakDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartPriceBreakDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartPriceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartPriceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartPriceDto": { "required": [ "imiPriceType", "imiPartPriceID" ], "type": "object", "properties": { "imiCreatedBy": { "type": "string" }, "imiCreatedDate": { "type": "string", "format": "date-time" }, "imiCurrencyRateID": { "type": "string" }, "imiCustomerGroupID": { "type": "string" }, "imiEndDate": { "type": "string", "format": "date-time" }, "imiUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imiInventoryPrice": { "type": "boolean" }, "imiLocationID": { "type": "string" }, "imiOrganizationID": { "type": "string" }, "imiPartGroupID": { "type": "string" }, "imiPartID": { "type": "string" }, "imiPartRevisionID": { "type": "string" }, "imiPriceType": { "type": "integer", "format": "int32" }, "imiQuoteID": { "type": "string" }, "imiRfqID": { "type": "string" }, "imiRowVersion": { "type": "integer", "format": "int64" }, "imiPartPriceID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "imiStartDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPPartPriceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartPriceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartRevisionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartRevisionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartRevisionDto": { "required": [ "imrEffectiveStartDate", "imrPartID", "imrShortDescription" ], "type": "object", "properties": { "imrAverageDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "imrAverageFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "imrAverageLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "imrAverageMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "imrAverageMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "imrAverageOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "imrAverageSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "imrBarLength": { "minimum": 0, "type": "number", "format": "double" }, "imrBlanketPeriodBegin": { "type": "string", "format": "date-time" }, "imrBlanketPeriodEnd": { "type": "string", "format": "date-time" }, "imrPartRevisionID": { "type": "string" }, "imrCommodityCode": { "type": "string" }, "imrCommodityDescription": { "type": "string" }, "imrConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "imrCountryOfManufacture": { "type": "string" }, "imrCreatedBy": { "type": "string" }, "imrCreatedDate": { "type": "string", "format": "date-time" }, "imrDocuments": { "type": "string" }, "imrEffectiveEndDate": { "type": "string", "format": "date-time" }, "imrEffectiveStartDate": { "type": "string", "format": "date-time" }, "imrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imrExpenseSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "imrFdxHandlingCost": { "minimum": 0, "type": "number", "format": "double" }, "imrFdxPackageHeight": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "imrFdxPackageLength": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "imrFdxPackageWidth": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "imrFdxPackaging": { "type": "string" }, "imrFdxPackagingCost": { "minimum": 0, "type": "number", "format": "double" }, "imrFdxShipCostMarkupPct": { "minimum": 0, "type": "number", "format": "double" }, "imrFormID": { "type": "string" }, "imrInspectionNotesRTF": { "type": "string" }, "imrInspectionNotesText": { "type": "string" }, "imrInventoryUnitOfMeasure": { "type": "string" }, "imrInactive": { "type": "boolean" }, "imrConfigured": { "type": "boolean" }, "imrFdxNonstandardContainer": { "type": "boolean" }, "imrFdxOneItemPerShipment": { "type": "boolean" }, "imrPreferredRefExists": { "type": "boolean" }, "imrPurchasableItem": { "type": "boolean" }, "imrSuppressShortDescription": { "type": "boolean" }, "imrUseQuotePrice": { "type": "boolean" }, "imrLastDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastReceiptDate": { "type": "string", "format": "date-time" }, "imrLastRunDatePurchasePlanner": { "type": "string", "format": "date-time" }, "imrLastSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "imrLastTransactionDate": { "type": "string", "format": "date-time" }, "imrLeadTime": { "type": "integer", "format": "int32" }, "imrLongDescriptionHtml": { "type": "string" }, "imrLongDescriptionRtf": { "type": "string" }, "imrLongDescriptionText": { "type": "string" }, "imrManufacturingLotSize": { "minimum": 0, "type": "number", "format": "double" }, "imrMaximumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imrMinimumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imrNetCostBeginDate": { "type": "string", "format": "date-time" }, "imrNetCostCode": { "type": "string" }, "imrNetCostEndDate": { "type": "string", "format": "date-time" }, "imrPartID": { "type": "string" }, "imrPartImageFileName": { "type": "string" }, "imrPreferenceCriteria": { "type": "string" }, "imrProducerDetermination": { "type": "string" }, "imrProductCategoryID": { "type": "string" }, "imrProductCategoryLineID": { "type": "integer", "format": "int32" }, "imrProductionNotesRTF": { "type": "string" }, "imrProductionNotesText": { "type": "string" }, "imrPurchaseLocationID": { "type": "string" }, "imrPurchaseUnitOfMeasure": { "type": "string" }, "imrQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "imrQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "imrQuantityOnOrderPurchases": { "minimum": 0, "type": "number", "format": "double" }, "imrQuantityOnOrderSales": { "minimum": 0, "type": "number", "format": "double" }, "imrQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "imrQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "imrQuantityToReturnJob": { "minimum": 0, "type": "number", "format": "double" }, "imrRequiresInspection": { "type": "integer", "format": "int32" }, "imrRowVersion": { "type": "integer", "format": "int64" }, "imrSheetSizeX": { "minimum": 0, "type": "number", "format": "double" }, "imrSheetSizeY": { "minimum": 0, "type": "number", "format": "double" }, "imrShortDescription": { "type": "string" }, "imrSourceMethodID": { "type": "string" }, "imrSourceRevisionID": { "type": "string" }, "imrStandardDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "imrStandardFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "imrStandardLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "imrStandardMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "imrStandardMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "imrStandardOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "imrStandardSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "imrSupplierOrganizationID": { "type": "string" }, "imrThickness": { "minimum": 0, "type": "number", "format": "double" }, "imrUniversalProductCode": { "type": "string" }, "imrVolume": { "minimum": 0, "type": "number", "format": "double" }, "imrWeight": { "minimum": 0, "type": "number", "format": "double" }, "imrWeightUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartRevisionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartRevisionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartDto": { "required": [ "impPartID", "impPartType", "impShortDescription" ], "type": "object", "properties": { "impPartID": { "type": "string" }, "impContractLength": { "type": "integer", "format": "int32" }, "impContractLengthType": { "type": "string" }, "impCreatedBy": { "type": "string" }, "impCreatedDate": { "type": "string", "format": "date-time" }, "impCycleCodeID": { "type": "string" }, "impDeliveryType": { "type": "integer", "format": "int32" }, "impUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "impInactiveDate": { "type": "string", "format": "date-time" }, "impInactive": { "type": "boolean" }, "impAlwaysNonTaxable": { "type": "boolean" }, "impBuyForInventory": { "type": "boolean" }, "impNonPhysicalShipment": { "type": "boolean" }, "impNonStockedItem": { "type": "boolean" }, "impPhantomOrKitPart": { "type": "boolean" }, "impTrackLotNumbers": { "type": "boolean" }, "impTrackSerialNumbers": { "type": "boolean" }, "impLongDescriptionRtf": { "type": "string" }, "impLongDescriptionText": { "type": "string" }, "impNextSerialNumberIDFormula": { "type": "string" }, "impNonTaxReasonID": { "type": "string" }, "impOEMOrganizationID": { "type": "string" }, "impPartClassID": { "type": "string" }, "impPartGroupID": { "type": "string" }, "impPartType": { "type": "integer", "format": "int32" }, "impReorderMethod": { "type": "integer", "format": "int32" }, "impRowVersion": { "type": "integer", "format": "int64" }, "impSecondTaxCodeID": { "type": "string" }, "impShortDescription": { "type": "string" }, "impTaxCodeID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartTransactionCostDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartTransactionCostDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartTransactionCostDto": { "required": [ "intPartTransactionID", "intPartTransactionCostID" ], "type": "object", "properties": { "intActualUnitDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "intActualUnitFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "intActualUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "intActualUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "intActualUnitMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "intActualUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "intActualUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "intCostType": { "type": "integer", "format": "int32" }, "intCreatedBy": { "type": "string" }, "intCreatedDate": { "type": "string", "format": "date-time" }, "intUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "intPartTransactionID": { "type": "integer", "format": "int32" }, "intPrevUnitDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "intPrevUnitFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "intPrevUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "intPrevUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "intPrevUnitMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "intPrevUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "intPrevUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "intQuantity": { "minimum": 0, "type": "number", "format": "double" }, "intRowVersion": { "type": "integer", "format": "int64" }, "intPartTransactionCostID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "intSourceTableName": { "type": "string" }, "intSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "intUnitDutyCost": { "minimum": 0, "type": "number", "format": "double" }, "intUnitFreightCost": { "minimum": 0, "type": "number", "format": "double" }, "intUnitLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "intUnitMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "intUnitMiscCost": { "minimum": 0, "type": "number", "format": "double" }, "intUnitOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "intUnitSubcontractCost": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPartTransactionCostDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartTransactionCostDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartTransactionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartTransactionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartTransactionDto": { "required": [ "imtPartBinID", "imtPartID", "imtPartWarehouseLocationID", "imtPartTransactionID", "imtTransactionDate", "imtUserID" ], "type": "object", "properties": { "imtCogsCalculatedDate": { "type": "string", "format": "date-time" }, "imtCreatedBy": { "type": "string" }, "imtCreatedDate": { "type": "string", "format": "date-time" }, "imtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imtHeatLot": { "type": "string" }, "imtInspectionStatus": { "type": "string" }, "imtInventoryQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "imtInventoryUnitOfMeasure": { "type": "string" }, "imtCogsPostedToGl": { "type": "boolean" }, "imtJobCompleteStatus": { "type": "boolean" }, "imtNonInventoryTransaction": { "type": "boolean" }, "imtNonNettable": { "type": "boolean" }, "imtPoLineReceivedComplete": { "type": "boolean" }, "imtRequiresInspection": { "type": "boolean" }, "imtIssueType": { "type": "integer", "format": "int32" }, "imtJobAssemblyID": { "type": "integer", "format": "int32" }, "imtJobID": { "type": "string" }, "imtJobMaterialComponentID": { "type": "integer", "format": "int32" }, "imtJobMaterialID": { "type": "integer", "format": "int32" }, "imtJobOperationID": { "type": "integer", "format": "int32" }, "imtJobType": { "type": "integer", "format": "int32" }, "imtPartBinID": { "type": "string" }, "imtPartID": { "type": "string" }, "imtPartRevisionID": { "type": "string" }, "imtPartWarehouseLocationID": { "type": "string" }, "imtPlantID": { "type": "string" }, "imtPreviousQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "imtProjectAreaID": { "type": "string" }, "imtProjectID": { "type": "string" }, "imtQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "imtQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "imtReceiptType": { "type": "integer", "format": "int32" }, "imtReference": { "type": "string" }, "imtRowVersion": { "type": "integer", "format": "int64" }, "imtScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imtPartTransactionID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "imtSetupCharge": { "minimum": 0, "type": "number", "format": "double" }, "imtSource": { "type": "integer", "format": "int32" }, "imtTableName": { "type": "string" }, "imtTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imtTransactionDate": { "type": "string", "format": "date-time" }, "imtTransactionType": { "type": "integer", "format": "int32" }, "imtUserID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPartTransactionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartTransactionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartUnitSalePriceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartUnitSalePriceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartUnitSalePriceDto": { "type": "object", "properties": { "imhCreatedBy": { "type": "string" }, "imhCreatedDate": { "type": "string", "format": "date-time" }, "imhCurrencyRateID": { "type": "string" }, "imhEndDate": { "type": "string", "format": "date-time" }, "imhUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imhPartID": { "type": "string" }, "imhPartRevisionID": { "type": "string" }, "imhRowVersion": { "type": "integer", "format": "int64" }, "imhPartUnitSalePriceID": { "type": "integer", "format": "int32" }, "imhStartDate": { "type": "string", "format": "date-time" }, "imhUnitSalePrice": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPartUnitSalePriceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartUnitSalePriceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPartWarehouseLocationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPartWarehouseLocationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPartWarehouseLocationDto": { "required": [ "imlPartID", "imlPartWarehouseID" ], "type": "object", "properties": { "imlCreatedBy": { "type": "string" }, "imlCreatedDate": { "type": "string", "format": "date-time" }, "imlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imlNonNettable": { "type": "boolean" }, "imLLastRunDatePurchasePlanner": { "type": "string", "format": "date-time" }, "imlMaximumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imlMinimumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "imlPartID": { "type": "string" }, "imlPartRevisionID": { "type": "string" }, "imlPartWarehouseID": { "type": "string" }, "imlQuantityInTransit": { "minimum": 0, "type": "number", "format": "double" }, "imlRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPartWarehouseLocationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPartWarehouseLocationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductCategoryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductCategoryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProductCategoryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductCategoryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductCategoryLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductCategoryLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProductCategoryLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductCategoryLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuantityAdjustmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuantityAdjustmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuantityAdjustmentDto": { "required": [ "inqAdjustmentDate", "inqAdjustmentType", "inqQuantityAdjustmentID", "inqPartBinID", "inqPartID", "inqPartWarehouseLocationID" ], "type": "object", "properties": { "inqAdjustmentDate": { "type": "string", "format": "date-time" }, "inqAdjustmentDescription": { "type": "string" }, "inqAdjustmentType": { "type": "integer", "format": "int32" }, "inqBinQuantityReceipted": { "minimum": 0, "type": "number", "format": "double" }, "inqBinQuantityTransferred": { "minimum": 0, "type": "number", "format": "double" }, "inqChangeQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inqQuantityAdjustmentID": { "type": "string" }, "inqCountedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inqCreatedBy": { "type": "string" }, "inqCreatedDate": { "type": "string", "format": "date-time" }, "inqCurrentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inqDestinationPartBinID": { "type": "string" }, "inqDestinationWarehouseID": { "type": "string" }, "inqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "inqPosted": { "type": "boolean" }, "inqNewQuantity": { "minimum": 0, "type": "number", "format": "double" }, "inqPartBinID": { "type": "string" }, "inqPartID": { "type": "string" }, "inqPartRevisionID": { "type": "string" }, "inqPartShortDescription": { "type": "string" }, "inqPartWarehouseLocationID": { "type": "string" }, "inqPlantDepartmentID": { "type": "string" }, "inqPlantID": { "type": "string" }, "inqPostedDate": { "type": "string", "format": "date-time" }, "inqQuantitySince": { "minimum": 0, "type": "number", "format": "double" }, "inqRowVersion": { "type": "integer", "format": "int64" }, "inqTransactionsSince": { "type": "integer", "format": "int32" }, "inqUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPQuantityAdjustmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuantityAdjustmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSerialNumberDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSerialNumberDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSerialNumberDto": { "required": [ "imsAddedByUserID", "imsAddedDate", "imsSerialNumberID", "imsPartID" ], "type": "object", "properties": { "imsAddedByUserID": { "type": "string" }, "imsAddedDate": { "type": "string", "format": "date-time" }, "imsSerialNumberID": { "type": "string" }, "imsCreatedBy": { "type": "string" }, "imsCreatedDate": { "type": "string", "format": "date-time" }, "imsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imsExpirationDate": { "type": "string", "format": "date-time" }, "imsInactiveDate": { "type": "string", "format": "date-time" }, "imsInactive": { "type": "boolean" }, "imsPartID": { "type": "string" }, "imsPartRevisionID": { "type": "string" }, "imsRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPSerialNumberDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSerialNumberDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSerialNumberStatusDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSerialNumberStatusDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSerialNumberStatusDto": { "required": [ "snsPartBinID", "snsPartID", "snsPartWarehouseLocationID", "snsSerialNumberID" ], "type": "object", "properties": { "snsCreatedBy": { "type": "string" }, "snsCreatedDate": { "type": "string", "format": "date-time" }, "snsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "snsPartBinID": { "type": "string" }, "snsPartID": { "type": "string" }, "snsPartRevisionID": { "type": "string" }, "snsPartWarehouseLocationID": { "type": "string" }, "snsQuantity": { "minimum": 0, "type": "number", "format": "double" }, "snsRowVersion": { "type": "integer", "format": "int64" }, "snsSerialNumberID": { "type": "string" }, "snsStatus": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSerialNumberStatusDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSerialNumberStatusDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSerialNumberTransactionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSerialNumberTransactionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSerialNumberTransactionDto": { "required": [ "sntOldTransactionType", "sntPartBinID", "sntPartID", "sntPartWarehouseLocationID", "sntSerialNumberTransactionID", "sntSerialNumberID", "sntTransactionDate", "sntTransactionType" ], "type": "object", "properties": { "sntCreatedBy": { "type": "string" }, "sntCreatedDate": { "type": "string", "format": "date-time" }, "sntDmrShipmentID": { "type": "string" }, "sntDmrShipmentLineID": { "type": "integer", "format": "int32" }, "sntUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sntInspectionID": { "type": "string" }, "sntInspectionLineID": { "type": "integer", "format": "int32" }, "sntInventoryCountID": { "type": "integer", "format": "int32" }, "sntInventoryCountLineID": { "type": "integer", "format": "int32" }, "sntInspect": { "type": "boolean" }, "sntNegativeTransaction": { "type": "boolean" }, "sntJobAssemblyID": { "type": "integer", "format": "int32" }, "sntJobID": { "type": "string" }, "sntJobMaterialComponentID": { "type": "integer", "format": "int32" }, "sntJobMaterialID": { "type": "integer", "format": "int32" }, "sntJobPartBinID": { "type": "string" }, "sntJobPartID": { "type": "string" }, "sntJobPartRevisionID": { "type": "string" }, "sntJobPartWarehouseLocationID": { "type": "string" }, "sntJobSerialNumberID": { "type": "string" }, "sntLandedCostID": { "type": "string" }, "sntOldTransactionType": { "type": "integer", "format": "int32" }, "sntPartBinID": { "type": "string" }, "sntPartID": { "type": "string" }, "sntPartRevisionID": { "type": "string" }, "sntPartTransactionID": { "type": "integer", "format": "int32" }, "sntPartWarehouseLocationID": { "type": "string" }, "sntQuantity": { "minimum": 0, "type": "number", "format": "double" }, "sntReceiptID": { "type": "string" }, "sntReceiptLineID": { "type": "integer", "format": "int32" }, "sntRmaReceiptID": { "type": "string" }, "sntRmaReceiptLineID": { "type": "integer", "format": "int32" }, "sntRowVersion": { "type": "integer", "format": "int64" }, "sntSerialNumberTransactionID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sntSerialNumberID": { "type": "string" }, "sntShipmentID": { "type": "string" }, "sntShipmentLineID": { "type": "integer", "format": "int32" }, "sntStatus": { "type": "integer", "format": "int32" }, "sntTableName": { "type": "string" }, "sntTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sntTransactionDate": { "type": "string", "format": "date-time" }, "sntTransactionType": { "type": "integer", "format": "int32" }, "sntWarehouseReceiptID": { "type": "string" }, "sntWarehouseReceiptLineID": { "type": "integer", "format": "int32" }, "sntWarehouseTransferID": { "type": "string" }, "sntWarehouseTransferLineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSerialNumberTransactionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSerialNumberTransactionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseBinDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseBinDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseBinDto": { "required": [ "inbWarehouseBinID", "inbDescription", "inbWarehouseID" ], "type": "object", "properties": { "inbWarehouseBinID": { "type": "string" }, "inbCreatedBy": { "type": "string" }, "inbCreatedDate": { "type": "string", "format": "date-time" }, "inbDescription": { "type": "string" }, "inbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "inbInactiveDate": { "type": "string", "format": "date-time" }, "inbInactive": { "type": "boolean" }, "inbDefaultBin": { "type": "boolean" }, "inbHasQOHQTI": { "type": "boolean" }, "inbLongDescriptionRtf": { "type": "string" }, "inbLongDescriptionText": { "type": "string" }, "inbRowVersion": { "type": "integer", "format": "int64" }, "inbWarehouseID": { "type": "string" } } }, "ERPResponseMessageDto[ERPWarehouseBinDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseBinDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseReceiptComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseReceiptComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseReceiptComponentDto": { "required": [ "wroDescription", "wroPartID", "wroWarehouseReceiptComponentID", "wroWarehouseReceiptID", "wroWarehouseReceiptLineID" ], "type": "object", "properties": { "wroAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "wroCreatedBy": { "type": "string" }, "wroCreatedDate": { "type": "string", "format": "date-time" }, "wroDescription": { "type": "string" }, "wroDestinationPartBinID": { "type": "string" }, "wroDestinationWarehouseID": { "type": "string" }, "wroUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wroClosed": { "type": "boolean" }, "wroPosted": { "type": "boolean" }, "wroReceivedComplete": { "type": "boolean" }, "wroReversed": { "type": "boolean" }, "wroParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "wroPartID": { "type": "string" }, "wroPartRevisionID": { "type": "string" }, "wroQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "wroQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "wroReverseWHReceiptCompID": { "type": "string" }, "wroReverseWHReceiptID": { "type": "string" }, "wroReverseWHReceiptLineID": { "type": "integer", "format": "int32" }, "wroRowVersion": { "type": "integer", "format": "int64" }, "wroWarehouseReceiptComponentID": { "type": "integer", "format": "int32" }, "wroSourcePartBinID": { "type": "string" }, "wroSourceTableName": { "type": "string" }, "wroSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wroSourceWarehouseID": { "type": "string" }, "wroUnitOfMeasure": { "type": "string" }, "wroWarehouseReceiptID": { "type": "string" }, "wroWarehouseReceiptLineID": { "type": "integer", "format": "int32" }, "wroWarehouseReqComponentID": { "type": "integer", "format": "int32" }, "wroWarehouseRequisitionID": { "type": "string" }, "wroWarehouseRequisitionLineID": { "type": "integer", "format": "int32" }, "wroWarehouseTransComponentID": { "type": "integer", "format": "int32" }, "wroWarehouseTransferID": { "type": "string" }, "wroWarehouseTransferLineID": { "type": "integer", "format": "int32" }, "wroWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPWarehouseReceiptComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseReceiptComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseReceiptLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseReceiptLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseReceiptLineDto": { "required": [ "wrlPartDescription", "wrlPartID", "wrlQuantityReceived", "wrlWarehouseReceiptLineID", "wrlWarehouseReceiptID" ], "type": "object", "properties": { "wrlCreatedBy": { "type": "string" }, "wrlCreatedDate": { "type": "string", "format": "date-time" }, "wrlDestinationPartBinID": { "type": "string" }, "wrlDestinationWarehouseID": { "type": "string" }, "wrlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wrlHeatLot": { "type": "string" }, "wrlClosed": { "type": "boolean" }, "wrlKitPart": { "type": "boolean" }, "wrlPosted": { "type": "boolean" }, "wrlReceivedComplete": { "type": "boolean" }, "wrlReversed": { "type": "boolean" }, "wrlPartDescription": { "type": "string" }, "wrlPartID": { "type": "string" }, "wrlPartRevisionID": { "type": "string" }, "wrlQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "wrlReference": { "type": "string" }, "wrlReverseWHReceiptID": { "type": "string" }, "wrlReverseWHReceiptLineID": { "type": "integer", "format": "int32" }, "wrlRowVersion": { "type": "integer", "format": "int64" }, "wrlWarehouseReceiptLineID": { "type": "integer", "format": "int32" }, "wrlSourcePartBinID": { "type": "string" }, "wrlSourceTableName": { "type": "string" }, "wrlSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wrlSourceWarehouseID": { "type": "string" }, "wrlUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "wrlUnitOfMeasure": { "type": "string" }, "wrlWarehouseReceiptID": { "type": "string" }, "wrlWarehouseRequisitionID": { "type": "string" }, "wrlWarehouseRequisitionLineID": { "type": "integer", "format": "int32" }, "wrlWarehouseTransferID": { "type": "string" }, "wrlWarehouseTransferLineID": { "type": "integer", "format": "int32" }, "wrlWTOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "wrlWTShippedQuantity": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPWarehouseReceiptLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseReceiptLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseReceiptDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseReceiptDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseReceiptDto": { "required": [ "wrpWarehouseReceiptID", "wrpDestinationWarehouseID", "wrpReceiptDate", "wrpSourceWarehouseID" ], "type": "object", "properties": { "wrpClosedDate": { "type": "string", "format": "date-time" }, "wrpWarehouseReceiptID": { "type": "string" }, "wrpCreatedBy": { "type": "string" }, "wrpCreatedDate": { "type": "string", "format": "date-time" }, "wrpDestinationWarehouseID": { "type": "string" }, "wrpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wrpFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "wrpClosed": { "type": "boolean" }, "wrpPosted": { "type": "boolean" }, "wrpReversalEntry": { "type": "boolean" }, "wrpReversed": { "type": "boolean" }, "wrpPostedDate": { "type": "string", "format": "date-time" }, "wrpReceiptDate": { "type": "string", "format": "date-time" }, "wrpRowVersion": { "type": "integer", "format": "int64" }, "wrpShippingMethodID": { "type": "string" }, "wrpShippingPaymentTypeID": { "type": "string" }, "wrpSourceWarehouseID": { "type": "string" } } }, "ERPResponseMessageDto[ERPWarehouseReceiptDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseReceiptDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseRequisitionComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseRequisitionComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseRequisitionComponentDto": { "required": [ "wqoDescription", "wqoPartID", "wqoQuantityRequested", "wqoWarehouseReqComponentID", "wqoWarehouseRequisitionID", "wqoWarehouseRequisitionLineID" ], "type": "object", "properties": { "wqoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "wqoCreatedBy": { "type": "string" }, "wqoCreatedDate": { "type": "string", "format": "date-time" }, "wqoDescription": { "type": "string" }, "wqoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wqoClosed": { "type": "boolean" }, "wqoTransferredComplete": { "type": "boolean" }, "wqoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "wqoPartID": { "type": "string" }, "wqoPartRevisionID": { "type": "string" }, "wqoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "wqoQuantityRequested": { "minimum": 0, "type": "number", "format": "double" }, "wqoQuantityTransferred": { "minimum": 0, "type": "number", "format": "double" }, "wqoRowVersion": { "type": "integer", "format": "int64" }, "wqoSourceWarehouseID": { "type": "string" }, "wqoUnitOfMeasure": { "type": "string" }, "wqoWarehouseReqComponentID": { "type": "integer", "format": "int32" }, "wqoWarehouseRequisitionID": { "type": "string" }, "wqoWarehouseRequisitionLineID": { "type": "integer", "format": "int32" }, "wqoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPWarehouseRequisitionComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseRequisitionComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseRequisitionLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseRequisitionLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseRequisitionLineDto": { "required": [ "wqlPartDescription", "wqlPartID", "wqlRequestedQuantity", "wqlWarehouseRequisitionLineID", "wqlWarehouseRequisitionID" ], "type": "object", "properties": { "wqlCreatedBy": { "type": "string" }, "wqlCreatedDate": { "type": "string", "format": "date-time" }, "wqlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wqlClosed": { "type": "boolean" }, "wqlKitPart": { "type": "boolean" }, "wqlTransferredComplete": { "type": "boolean" }, "wqlPartDescription": { "type": "string" }, "wqlPartID": { "type": "string" }, "wqlPartRevisionID": { "type": "string" }, "wqlQuantityTransferred": { "minimum": 0, "type": "number", "format": "double" }, "wqlRequestedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "wqlRowVersion": { "type": "integer", "format": "int64" }, "wqlWarehouseRequisitionLineID": { "type": "integer", "format": "int32" }, "wqlSourceWarehouseID": { "type": "string" }, "wqlUnitOfMeasure": { "type": "string" }, "wqlWarehouseRequisitionID": { "type": "string" } } }, "ERPResponseMessageDto[ERPWarehouseRequisitionLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseRequisitionLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseRequisitionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseRequisitionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseRequisitionDto": { "required": [ "wqpWarehouseRequisitionID", "wqpDestinationWarehouseID", "wqpRequestedShipDate", "wqpRequisitionDate", "wqpSourceWarehouseID", "wqpStatus" ], "type": "object", "properties": { "wqpClosedDate": { "type": "string", "format": "date-time" }, "wqpWarehouseRequisitionID": { "type": "string" }, "wqpCreatedBy": { "type": "string" }, "wqpCreatedDate": { "type": "string", "format": "date-time" }, "wqpDestinationWarehouseID": { "type": "string" }, "wqpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "wqpClosed": { "type": "boolean" }, "wqpReadyToPrint": { "type": "boolean" }, "wqpRequestedShipDate": { "type": "string", "format": "date-time" }, "wqpRequisitionCommentsRTF": { "type": "string" }, "wqpRequisitionCommentsText": { "type": "string" }, "wqpRequisitionDate": { "type": "string", "format": "date-time" }, "wqpRowVersion": { "type": "integer", "format": "int64" }, "wqpShippingMethodID": { "type": "string" }, "wqpShippingPaymentTypeID": { "type": "string" }, "wqpSourceWarehouseID": { "type": "string" }, "wqpStatus": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPWarehouseRequisitionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseRequisitionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseDto": { "required": [ "imwWarehouseID", "imwName" ], "type": "object", "properties": { "imwAddressLine1": { "type": "string" }, "imwAddressLine2": { "type": "string" }, "imwAddressLine3": { "type": "string" }, "imwCity": { "type": "string" }, "imwWarehouseID": { "type": "string" }, "imwCountry": { "type": "string" }, "imwCreatedBy": { "type": "string" }, "imwCreatedDate": { "type": "string", "format": "date-time" }, "imwDefaultBinCount": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "imwEmailAddress": { "type": "string" }, "imwUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imwEstablishedDate": { "type": "string", "format": "date-time" }, "imwFaxNumber": { "type": "string" }, "imwInactiveDate": { "type": "string", "format": "date-time" }, "imwInactive": { "type": "boolean" }, "imwAvalaraAddressValidated": { "type": "boolean" }, "imwDefaultWarehouse": { "type": "boolean" }, "imwDoNotIncludeInJobCosts": { "type": "boolean" }, "imwNonNettable": { "type": "boolean" }, "imwName": { "type": "string" }, "imwNonNettableType": { "type": "integer", "format": "int32" }, "imwPhoneNumber": { "type": "string" }, "imwPlantDepartmentID": { "type": "string" }, "imwPlantID": { "type": "string" }, "imwPostCode": { "type": "string" }, "imwRowVersion": { "type": "integer", "format": "int64" }, "imwShippingMethodID": { "type": "string" }, "imwState": { "type": "string" } } }, "ERPResponseMessageDto[ERPWarehouseDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseTransferComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseTransferComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseTransferComponentDto": { "required": [ "mwoDescription", "mwoPartID", "mwoWarehouseTransComponentID", "mwoWarehouseTransferID", "mwoWarehouseTransferLineID" ], "type": "object", "properties": { "mwoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwoCreatedBy": { "type": "string" }, "mwoCreatedDate": { "type": "string", "format": "date-time" }, "mwoDescription": { "type": "string" }, "mwoDestinationWarehouseID": { "type": "string" }, "mwoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mwoClosed": { "type": "boolean" }, "mwoPosted": { "type": "boolean" }, "mwoReceivedComplete": { "type": "boolean" }, "mwoReversed": { "type": "boolean" }, "mwoShippedComplete": { "type": "boolean" }, "mwoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwoPartID": { "type": "string" }, "mwoPartRevisionID": { "type": "string" }, "mwoQuantityInTransit": { "minimum": 0, "type": "number", "format": "double" }, "mwoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "mwoReceivedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwoReverseWHTransComponentID": { "type": "integer", "format": "int32" }, "mwoReverseWHTransferID": { "type": "string" }, "mwoReverseWHTransferLineID": { "type": "integer", "format": "int32" }, "mwoRowVersion": { "type": "integer", "format": "int64" }, "mwoShipQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwoSourcePartBinID": { "type": "string" }, "mwoSourceWarehouseID": { "type": "string" }, "mwoUnitOfMeasure": { "type": "string" }, "mwoWarehouseReqComponentID": { "type": "integer", "format": "int32" }, "mwoWarehouseRequisitionID": { "type": "string" }, "mwoWarehouseRequisitionLineID": { "type": "integer", "format": "int32" }, "mwoWarehouseTransComponentID": { "type": "integer", "format": "int32" }, "mwoWarehouseTransferID": { "type": "string" }, "mwoWarehouseTransferLineID": { "type": "integer", "format": "int32" }, "mwoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPWarehouseTransferComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseTransferComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseTransferLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseTransferLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseTransferLineDto": { "required": [ "mwlPartDescription", "mwlPartID", "mwlWarehouseTransferLineID", "mwlShipQuantity", "mwlWarehouseTransferID" ], "type": "object", "properties": { "mwlCreatedBy": { "type": "string" }, "mwlCreatedDate": { "type": "string", "format": "date-time" }, "mwlDestinationWarehouseID": { "type": "string" }, "mwlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mwlClosed": { "type": "boolean" }, "mwlKitPart": { "type": "boolean" }, "mwlPosted": { "type": "boolean" }, "mwlReceivedComplete": { "type": "boolean" }, "mwlReversed": { "type": "boolean" }, "mwlShippedComplete": { "type": "boolean" }, "mwlPartDescription": { "type": "string" }, "mwlPartID": { "type": "string" }, "mwlPartRevisionID": { "type": "string" }, "mwlQuantityInTransit": { "minimum": 0, "type": "number", "format": "double" }, "mwlReceivedDate": { "type": "string", "format": "date-time" }, "mwlReceivedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwlReverseWHTransferID": { "type": "string" }, "mwlReverseWHTransferLineID": { "type": "integer", "format": "int32" }, "mwlRowVersion": { "type": "integer", "format": "int64" }, "mwlWarehouseTransferLineID": { "type": "integer", "format": "int32" }, "mwlShipQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwlSourcePartBinID": { "type": "string" }, "mwlSourceWarehouseID": { "type": "string" }, "mwlUnitOfMeasure": { "type": "string" }, "mwlWarehouseRequisitionID": { "type": "string" }, "mwlWarehouseRequisitionLineID": { "type": "integer", "format": "int32" }, "mwlWarehouseTransferID": { "type": "string" }, "mwlWROpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mwlWRRequestedQuantity": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPWarehouseTransferLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseTransferLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWarehouseTransferDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWarehouseTransferDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWarehouseTransferDto": { "required": [ "mwpWarehouseTransferID", "mwpDestinationWarehouseID", "mwpShipDate", "mwpSourceWarehouseID" ], "type": "object", "properties": { "mwpClosedDate": { "type": "string", "format": "date-time" }, "mwpWarehouseTransferID": { "type": "string" }, "mwpCreatedBy": { "type": "string" }, "mwpCreatedDate": { "type": "string", "format": "date-time" }, "mwpDestinationWarehouseID": { "type": "string" }, "mwpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mwpFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "mwpClosed": { "type": "boolean" }, "mwpPosted": { "type": "boolean" }, "mwpPrintLabels": { "type": "boolean" }, "mwpPrintPacker": { "type": "boolean" }, "mwpReversalEntry": { "type": "boolean" }, "mwpReversed": { "type": "boolean" }, "mwpNumberOfLabels": { "type": "integer", "format": "int32" }, "mwpPostedDate": { "type": "string", "format": "date-time" }, "mwpRowVersion": { "type": "integer", "format": "int64" }, "mwpShipDate": { "type": "string", "format": "date-time" }, "mwpShippingCommentsRTF": { "type": "string" }, "mwpShippingCommentsText": { "type": "string" }, "mwpShippingMethodID": { "type": "string" }, "mwpShippingPaymentTypeID": { "type": "string" }, "mwpSourceWarehouseID": { "type": "string" }, "mwpTrackingNumber": { "type": "string" } } }, "ERPResponseMessageDto[ERPWarehouseTransferDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWarehouseTransferDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPChangeRequestGroupLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPChangeRequestGroupLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPChangeRequestGroupLinkDto": { "required": [ "chrChangeRequestGroupID", "chrChangeRequestID", "chrChangeRequestGroupLinkID" ], "type": "object", "properties": { "chrChangeRequestGroupID": { "type": "string" }, "chrChangeRequestID": { "type": "string" }, "chrCreatedBy": { "type": "string" }, "chrCreatedDate": { "type": "string", "format": "date-time" }, "chrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "chrRowVersion": { "type": "integer", "format": "int64" }, "chrChangeRequestGroupLinkID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPChangeRequestGroupLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPChangeRequestGroupLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPChangeRequestGroupDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPChangeRequestGroupDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPChangeRequestGroupDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPChangeRequestGroupDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPChangeRequestDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPChangeRequestDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPChangeRequestDto": { "required": [ "chpChangeRequestTypeID", "chpChangeRequestID", "chpOpenedByEmployeeID", "chpOpenedDate", "chpPartID", "chpShortDescription", "chpStatus" ], "type": "object", "properties": { "chpActualHours": { "minimum": 0, "type": "number", "format": "double" }, "chpAssignedDate": { "type": "string", "format": "date-time" }, "chpAssignedToEmployeeID": { "type": "string" }, "chpAuthorizedByEmployeeID": { "type": "string" }, "chpAuthorizedDate": { "type": "string", "format": "date-time" }, "chpChangeRequestTypeID": { "type": "string" }, "chpClosedByEmployeeID": { "type": "string" }, "chpClosedDate": { "type": "string", "format": "date-time" }, "chpClosedReasonID": { "type": "string" }, "chpChangeRequestID": { "type": "string" }, "chpCreatedBy": { "type": "string" }, "chpCreatedDate": { "type": "string", "format": "date-time" }, "chpDueDate": { "type": "string", "format": "date-time" }, "chpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "chpEstimatedHours": { "minimum": 0, "type": "number", "format": "double" }, "chpJobID": { "type": "string" }, "chpLongDescriptionRtf": { "type": "string" }, "chpLongDescriptionText": { "type": "string" }, "chpNonConformanceID": { "type": "string" }, "chpOpenedByEmployeeID": { "type": "string" }, "chpOpenedDate": { "type": "string", "format": "date-time" }, "chpPartID": { "type": "string" }, "chpPartRevisionID": { "type": "string" }, "chpPriorityID": { "type": "integer", "format": "int32" }, "chpProjectAreaID": { "type": "string" }, "chpProjectID": { "type": "string" }, "chpResolvedPartID": { "type": "string" }, "chpResolvedPartRevisionID": { "type": "string" }, "chpRowVersion": { "type": "integer", "format": "int64" }, "chpShortDescription": { "type": "string" }, "chpStatus": { "type": "string" } } }, "ERPResponseMessageDto[ERPChangeRequestDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPChangeRequestDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPChangeRequestTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPChangeRequestTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPChangeRequestTypeDto": { "required": [ "chtChangeRequestTypeID", "chtDescription" ], "type": "object", "properties": { "chtChangeRequestTypeID": { "type": "string" }, "chtCreatedBy": { "type": "string" }, "chtCreatedDate": { "type": "string", "format": "date-time" }, "chtDescription": { "type": "string" }, "chtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "chtInactiveDate": { "type": "string", "format": "date-time" }, "chtInactive": { "type": "boolean" }, "chtRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPChangeRequestTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPChangeRequestTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobAssemblyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobAssemblyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobAssemblyDto": { "required": [ "jmaJobID", "jmaLevel", "jmaPartBinID", "jmaPartID", "jmaPartShortDescription", "jmaQuantityPerParent", "jmaJobAssemblyID" ], "type": "object", "properties": { "jmaAssemblyOverlap": { "type": "integer", "format": "int32" }, "jmaCompletedDate": { "type": "string", "format": "date-time" }, "jmaCreatedBy": { "type": "string" }, "jmaCreatedDate": { "type": "string", "format": "date-time" }, "jmaDocuments": { "type": "string" }, "jmaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmaEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "jmaInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmaClosed": { "type": "boolean" }, "jmaIssuedComplete": { "type": "boolean" }, "jmaProductionComplete": { "type": "boolean" }, "jmaPullAllFromStock": { "type": "boolean" }, "jmaReceivedComplete": { "type": "boolean" }, "jmaJobID": { "type": "string" }, "jmaLevel": { "type": "integer", "format": "int32" }, "jmaOrderQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmaOverlapDestinationLink": { "type": "integer", "format": "int32" }, "jmaOverlapOffsetTime": { "minimum": 0, "type": "number", "format": "double" }, "jmaOverlapOperationID": { "type": "integer", "format": "int32" }, "jmaOverlapSourceLink": { "type": "integer", "format": "int32" }, "jmaOverlapSourceOperationID": { "type": "integer", "format": "int32" }, "jmaOverlapType": { "type": "integer", "format": "int32" }, "jmaParentAssemblyID": { "type": "integer", "format": "int32" }, "jmaPartBinID": { "type": "string" }, "jmaPartID": { "type": "string" }, "jmaPartLongDescriptionRtf": { "type": "string" }, "jmaPartLongDescriptionText": { "type": "string" }, "jmaPartRevisionID": { "type": "string" }, "jmaPartShortDescription": { "type": "string" }, "jmaPartWareHouseLocationID": { "type": "string" }, "jmaProductionNotesRTF": { "type": "string" }, "jmaProductionNotesText": { "type": "string" }, "jmaProductionQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityCompleted": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityIssued": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityReceivedToInventory": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityToMake": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityToPull": { "minimum": 0, "type": "number", "format": "double" }, "jmaQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "jmaReworkDate": { "type": "string", "format": "date-time" }, "jmaReworkQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmaRowVersion": { "type": "integer", "format": "int64" }, "jmaScheduledDueDate": { "type": "string", "format": "date-time" }, "jmaScheduledDueHour": { "minimum": 0, "type": "number", "format": "double" }, "jmaScheduledStartDate": { "type": "string", "format": "date-time" }, "jmaScheduledStartHour": { "minimum": 0, "type": "number", "format": "double" }, "jmaScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmaScrapQuantityCompleted": { "minimum": 0, "type": "number", "format": "double" }, "jmaJobAssemblyID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "jmaSourceMethodID": { "type": "string" }, "jmaSourceRevisionID": { "type": "string" }, "jmaUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPJobAssemblyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobAssemblyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobCostDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobCostDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobCostDto": { "required": [ "jmcApInvoiceID", "jmcJobID", "jmcPartID", "jmcQuantityReceived", "jmcTransactionDate" ], "type": "object", "properties": { "jmcApInvoiceID": { "type": "string" }, "jmcApInvoiceLineID": { "type": "integer", "format": "int32" }, "jmcCostSequence": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "jmcCreatedBy": { "type": "string" }, "jmcCreatedDate": { "type": "string", "format": "date-time" }, "jmcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmcHeatLot": { "type": "string" }, "jmcJobAssemblyID": { "type": "integer", "format": "int32" }, "jmcJobID": { "type": "string" }, "jmcJobMaterialComponentID": { "type": "integer", "format": "int32" }, "jmcJobMaterialID": { "type": "integer", "format": "int32" }, "jmcJobOperationID": { "type": "integer", "format": "int32" }, "jmcJobSequence": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "jmcJobType": { "type": "integer", "format": "int32" }, "jmcPartDescription": { "type": "string" }, "jmcPartID": { "type": "string" }, "jmcPartRevisionID": { "type": "string" }, "jmcQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "jmcReceiptComponentID": { "type": "integer", "format": "int32" }, "jmcReceiptID": { "type": "string" }, "jmcReceiptLineID": { "type": "integer", "format": "int32" }, "jmcReceivedUnitOfMeasure": { "type": "string" }, "jmcReference": { "type": "string" }, "jmcRowVersion": { "type": "integer", "format": "int64" }, "jmcSource": { "type": "integer", "format": "int32" }, "jmcSupplierOrganizationID": { "type": "string" }, "jmcTotalCogsCost": { "minimum": 0, "type": "number", "format": "double" }, "jmcTotalCost": { "minimum": 0, "type": "number", "format": "double" }, "jmcTransactionDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPJobCostDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobCostDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobMaterialComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobMaterialComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobMaterialComponentDto": { "required": [ "jmtDescription", "jmtJobID", "jmtJobMaterialID", "jmtMaterialQuantity", "jmtPartBinID", "jmtPartID", "jmtPartWarehouseLocationID", "jmtJobMaterialComponentID" ], "type": "object", "properties": { "jmtAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmtCreatedBy": { "type": "string" }, "jmtCreatedDate": { "type": "string", "format": "date-time" }, "jmtDescription": { "type": "string" }, "jmtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmtClosed": { "type": "boolean" }, "jmtPullAllFromStock": { "type": "boolean" }, "jmtReceivedComplete": { "type": "boolean" }, "jmtJobAssemblyID": { "type": "integer", "format": "int32" }, "jmtJobID": { "type": "string" }, "jmtJobMaterialID": { "type": "integer", "format": "int32" }, "jmtMaterialQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmtParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmtPartBinID": { "type": "string" }, "jmtPartID": { "type": "string" }, "jmtPartRevisionID": { "type": "string" }, "jmtPartWarehouseLocationID": { "type": "string" }, "jmtQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "jmtQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "jmtQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "jmtQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "jmtQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "jmtRowVersion": { "type": "integer", "format": "int64" }, "jmtScrapQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "jmtJobMaterialComponentID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "jmtUnitOfMeasure": { "type": "string" }, "jmtWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPJobMaterialComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobMaterialComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobMaterialDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobMaterialDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobMaterialDto": { "required": [ "jmmJobID", "jmmPartBinID", "jmmPartID", "jmmPartShortDescription", "jmmPartWarehouseLocationID", "jmmJobMaterialID" ], "type": "object", "properties": { "jmmCalculatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "jmmCreatedBy": { "type": "string" }, "jmmCreatedDate": { "type": "string", "format": "date-time" }, "jmmDocuments": { "type": "string" }, "jmmDueInDate": { "type": "string", "format": "date-time" }, "jmmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmmEstimatedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmmEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "jmmBackflush": { "type": "boolean" }, "jmmClosed": { "type": "boolean" }, "jmmCostOverride": { "type": "boolean" }, "jmmFirm": { "type": "boolean" }, "jmmKitPart": { "type": "boolean" }, "jmmPullAllFromStock": { "type": "boolean" }, "jmmReceivedComplete": { "type": "boolean" }, "jmmJobAssemblyID": { "type": "integer", "format": "int32" }, "jmmJobID": { "type": "string" }, "jmmLeadTime": { "type": "integer", "format": "int32" }, "jmmLeadTime1": { "type": "integer", "format": "int32" }, "jmmLeadTime2": { "type": "integer", "format": "int32" }, "jmmLeadTime3": { "type": "integer", "format": "int32" }, "jmmLeadTime4": { "type": "integer", "format": "int32" }, "jmmLeadTime5": { "type": "integer", "format": "int32" }, "jmmLeadTime6": { "type": "integer", "format": "int32" }, "jmmLeadTime7": { "type": "integer", "format": "int32" }, "jmmLeadTime8": { "type": "integer", "format": "int32" }, "jmmLeadTime9": { "type": "integer", "format": "int32" }, "jmmMinimumCharge": { "minimum": 0, "type": "number", "format": "double" }, "jmmOrderByDate": { "type": "string", "format": "date-time" }, "jmmPartBinID": { "type": "string" }, "jmmPartID": { "type": "string" }, "jmmPartLongDescriptionRtf": { "type": "string" }, "jmmPartLongDescriptionText": { "type": "string" }, "jmmPartRevisionID": { "type": "string" }, "jmmPartShortDescription": { "type": "string" }, "jmmPartWarehouseLocationID": { "type": "string" }, "jmmPullFromStockQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmmPurchaseLocationID": { "type": "string" }, "jmmPurchaseOrderID": { "type": "string" }, "jmmPurchaseToJobQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak1": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak2": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak3": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak4": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak5": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak6": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak7": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak8": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityBreak9": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityPerAssembly": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "jmmQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "jmmRelatedJobOperationID": { "type": "integer", "format": "int32" }, "jmmRequiredDate": { "type": "string", "format": "date-time" }, "jmmRfqID": { "type": "string" }, "jmmRowVersion": { "type": "integer", "format": "int64" }, "jmmScrapPercent": { "minimum": 0, "type": "number", "format": "double" }, "jmmScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmmScrapQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "jmmJobMaterialID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "jmmSupplierOrganizationID": { "type": "string" }, "jmmUnitCost1": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost2": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost3": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost4": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost5": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost6": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost7": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost8": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitCost9": { "minimum": 0, "type": "number", "format": "double" }, "jmmUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPJobMaterialDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobMaterialDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobMemoDto": { "required": [ "jmkJobID", "jmkMemoDate", "jmkJobMemoID", "jmkShortDescription" ], "type": "object", "properties": { "jmkCreatedBy": { "type": "string" }, "jmkCreatedDate": { "type": "string", "format": "date-time" }, "jmkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmkClosed": { "type": "boolean" }, "jmkJobID": { "type": "string" }, "jmkLongDescriptionRtf": { "type": "string" }, "jmkLongDescriptionText": { "type": "string" }, "jmkMemoDate": { "type": "string", "format": "date-time" }, "jmkRowVersion": { "type": "integer", "format": "int64" }, "jmkJobMemoID": { "type": "integer", "format": "int32" }, "jmkShortDescription": { "type": "string" }, "jmkShowInJobs": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPJobMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobOperationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobOperationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobOperationDto": { "required": [ "jmoJobID", "jmoMachineType", "jmoOperationType", "jmoProcessID", "jmoProcessShortDescription", "jmoQuantityPerAssembly", "jmoJobOperationID", "jmoStandardFactor", "jmoWorkCenterID" ], "type": "object", "properties": { "jmoActualProductionHours": { "minimum": 0, "type": "number", "format": "double" }, "jmoActualSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "jmoCalculatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "jmoCompletedProductionHours": { "minimum": 0, "type": "number", "format": "double" }, "jmoCompletedSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "jmoCreatedBy": { "type": "string" }, "jmoCreatedDate": { "type": "string", "format": "date-time" }, "jmoDocuments": { "type": "string" }, "jmoDueDate": { "type": "string", "format": "date-time" }, "jmoDueHour": { "minimum": 0, "type": "number", "format": "double" }, "jmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmoEstimatedProductionHours": { "minimum": 0, "type": "number", "format": "double" }, "jmoEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "jmoInspectionStatus": { "type": "integer", "format": "int32" }, "jmoInspectionType": { "type": "integer", "format": "int32" }, "jmoAddedOperation": { "type": "boolean" }, "jmoClosed": { "type": "boolean" }, "jmoFirm": { "type": "boolean" }, "jmoInspectionComplete": { "type": "boolean" }, "jmoProductionComplete": { "type": "boolean" }, "jmoPrototypeOperation": { "type": "boolean" }, "jmoSetupComplete": { "type": "boolean" }, "jmoJobAssemblyID": { "type": "integer", "format": "int32" }, "jmoJobID": { "type": "string" }, "jmoMachinesToSchedule": { "type": "integer", "format": "int32" }, "jmoMachineType": { "type": "integer", "format": "int32" }, "jmoMinimumCharge": { "minimum": 0, "type": "number", "format": "double" }, "jmoMoveTime": { "minimum": 0, "type": "number", "format": "double" }, "jmoOperationQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmoOperationType": { "type": "integer", "format": "int32" }, "jmoOverheadRate": { "minimum": 0, "type": "number", "format": "double" }, "jmoOverlap": { "type": "integer", "format": "int32" }, "jmoOverlapDestinationLink": { "type": "integer", "format": "int32" }, "jmoOverlapOffsetTime": { "minimum": 0, "type": "number", "format": "double" }, "jmoOverlapOperationID": { "type": "integer", "format": "int32" }, "jmoOverlapSourceLink": { "type": "integer", "format": "int32" }, "jmoPartBinID": { "type": "string" }, "jmoPartID": { "type": "string" }, "jmoPartRevisionID": { "type": "string" }, "jmoPartWarehouseLocationID": { "type": "string" }, "jmoPlantDepartmentID": { "type": "string" }, "jmoPlantID": { "type": "string" }, "jmoProcessID": { "type": "string" }, "jmoProcessLongDescriptionRtf": { "type": "string" }, "jmoProcessLongDescriptionText": { "type": "string" }, "jmoProcessShortDescription": { "type": "string" }, "jmoProductionRate": { "minimum": 0, "type": "number", "format": "double" }, "jmoProductionStandard": { "minimum": 0, "type": "number", "format": "double" }, "jmoPurchaseLocationID": { "type": "string" }, "jmoPurchaseOrderID": { "type": "string" }, "jmoQuantityBreak1": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak2": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak3": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak4": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak5": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak6": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak7": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak8": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityBreak9": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityComplete": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityPerAssembly": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "jmoQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "jmoQueueTime": { "minimum": 0, "type": "number", "format": "double" }, "jmoRfqID": { "type": "string" }, "jmoRowVersion": { "type": "integer", "format": "int64" }, "jmoScrapQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "jmoJobOperationID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "jmoSetupCharge": { "minimum": 0, "type": "number", "format": "double" }, "jmoSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "jmoSetupPercentComplete": { "type": "integer", "format": "int32" }, "jmoSetupRate": { "minimum": 0, "type": "number", "format": "double" }, "jmoSfeMessageRTF": { "type": "string" }, "jmoSfeMessageText": { "type": "string" }, "jmoStandardFactor": { "type": "string" }, "jmoStartDate": { "type": "string", "format": "date-time" }, "jmoStartHour": { "minimum": 0, "type": "number", "format": "double" }, "jmoSupplierOrganizationID": { "type": "string" }, "jmoUnitCost1": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost2": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost3": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost4": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost5": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost6": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost7": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost8": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitCost9": { "minimum": 0, "type": "number", "format": "double" }, "jmoUnitOfMeasure": { "type": "string" }, "jmoWorkCenterID": { "type": "string" }, "jmoWorkCenterMachineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPJobOperationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobOperationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobPriorityDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobPriorityDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobPriorityDto": { "required": [ "jmjDescription", "jmjJobPriorityID" ], "type": "object", "properties": { "jmjDescription": { "type": "string" }, "jmjUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmjRowVersion": { "type": "integer", "format": "int64" }, "jmjJobPriorityID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPJobPriorityDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobPriorityDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobDto": { "required": [ "jmpJobID", "jmpJobDate", "jmpPartBinID", "jmpPartID", "jmpPartShortDescription" ], "type": "object", "properties": { "jmpCallID": { "type": "string" }, "jmpClosedDate": { "type": "string", "format": "date-time" }, "jmpJobID": { "type": "string" }, "jmpCompletedDate": { "type": "string", "format": "date-time" }, "jmpCreatedBy": { "type": "string" }, "jmpCreatedDate": { "type": "string", "format": "date-time" }, "jmpCustomerOrganizationID": { "type": "string" }, "jmpDocuments": { "type": "string" }, "jmpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmpInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmpClosed": { "type": "boolean" }, "jmpFirm": { "type": "boolean" }, "jmpNestlinkProcessed": { "type": "boolean" }, "jmpOnHold": { "type": "boolean" }, "jmpPlanningComplete": { "type": "boolean" }, "jmpProductionComplete": { "type": "boolean" }, "jmpReadyToPrint": { "type": "boolean" }, "jmpReleasedToFloor": { "type": "boolean" }, "jmpScheduleComplete": { "type": "boolean" }, "jmpScheduleLocked": { "type": "boolean" }, "jmpTimeAndMaterial": { "type": "boolean" }, "jmpJobDate": { "type": "string", "format": "date-time" }, "jmpJobPriorityID": { "type": "integer", "format": "int32" }, "jmpNonConformanceID": { "type": "string" }, "jmpOrderQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmpPartBinID": { "type": "string" }, "jmpPartForecastPeriodID": { "type": "integer", "format": "int32" }, "jmpPartForecastYearID": { "type": "integer", "format": "int32" }, "jmpPartID": { "type": "string" }, "jmpPartLongDescriptionRtf": { "type": "string" }, "jmpPartLongDescriptionText": { "type": "string" }, "jmpPartRevisionID": { "type": "string" }, "jmpPartShortDescription": { "type": "string" }, "jmpPartWareHouseLocationID": { "type": "string" }, "jmpPlannerEmployeeID": { "type": "string" }, "jmpPlantDepartmentID": { "type": "string" }, "jmpPlantID": { "type": "string" }, "jmpProductionDueDate": { "type": "string", "format": "date-time" }, "jmpProductionNotesRTF": { "type": "string" }, "jmpProductionNotesText": { "type": "string" }, "jmpProductionQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmpProjectAreaID": { "type": "string" }, "jmpProjectID": { "type": "string" }, "jmpQuantityCompleted": { "minimum": 0, "type": "number", "format": "double" }, "jmpQuantityReceivedToInventory": { "minimum": 0, "type": "number", "format": "double" }, "jmpQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "jmpQuoteID": { "type": "string" }, "jmpQuoteLineID": { "type": "integer", "format": "int32" }, "jmpReworkDate": { "type": "string", "format": "date-time" }, "jmpReworkQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmpRmaClaimID": { "type": "string" }, "jmpRmaClaimLineID": { "type": "integer", "format": "int32" }, "jmpRowVersion": { "type": "integer", "format": "int64" }, "jmpScheduledDueDate": { "type": "string", "format": "date-time" }, "jmpScheduledDueHour": { "minimum": 0, "type": "number", "format": "double" }, "jmpScheduledStartDate": { "type": "string", "format": "date-time" }, "jmpScheduledStartHour": { "minimum": 0, "type": "number", "format": "double" }, "jmpScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "jmpScrapQuantityCompleted": { "minimum": 0, "type": "number", "format": "double" }, "jmpShipLocationID": { "type": "string" }, "jmpShipOrganizationID": { "type": "string" }, "jmpSourceMethodID": { "type": "string" }, "jmpSourceRevisionID": { "type": "string" }, "jmpUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPJobDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPJobScenarioDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPJobScenarioDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPJobScenarioDto": { "required": [ "jmnJobScenarioID", "jmnDescription" ], "type": "object", "properties": { "jmnJobScenarioID": { "type": "string" }, "jmnCreatedBy": { "type": "string" }, "jmnCreatedDate": { "type": "string", "format": "date-time" }, "jmnDescription": { "type": "string" }, "jmnUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmnRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPJobScenarioDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPJobScenarioDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMRPDemandDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMRPDemandDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMRPDemandDto": { "required": [ "mrrDemandID", "mrrDueDate", "mrrLineID", "mrrPartBinID", "mrrPartID", "mrrPartWarehouseLocationID", "mrrSessionID" ], "type": "object", "properties": { "mrrCreatedBy": { "type": "string" }, "mrrCreatedDate": { "type": "string", "format": "date-time" }, "mrrCustomerOrganizationID": { "type": "string" }, "mrrDemandID": { "type": "integer", "format": "int32" }, "mrrDemandQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mrrDueDate": { "type": "string", "format": "date-time" }, "mrrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mrrJobAssemblyID": { "type": "integer", "format": "int32" }, "mrrJobID": { "type": "string" }, "mrrJobMaterialID": { "type": "integer", "format": "int32" }, "mrrLineID": { "type": "integer", "format": "int32" }, "mrrOriginalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mrrPartBinID": { "type": "string" }, "mrrPartID": { "type": "string" }, "mrrPartPlantID": { "type": "string" }, "mrrPartRevisionID": { "type": "string" }, "mrrPartWarehouseLocationID": { "type": "string" }, "mrrQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "mrrQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "mrrRowVersion": { "type": "integer", "format": "int64" }, "mrrSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "mrrSalesOrderID": { "type": "string" }, "mrrSalesOrderLineID": { "type": "integer", "format": "int32" }, "mrrSessionID": { "type": "string" }, "mrrShipLocationID": { "type": "string" }, "mrrShipOrganizationID": { "type": "string" }, "mrrSource": { "type": "string" }, "mrrType": { "type": "string" } } }, "ERPResponseMessageDto[ERPMRPDemandDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMRPDemandDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMRPJobDetailDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMRPJobDetailDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMRPJobDetailDto": { "required": [ "mrjJobDetailID", "mrjLineID", "mrjPartBinID", "mrjPartID", "mrjPartWarehouseLocationID", "mrjProductionDueDate", "mrjSessionID" ], "type": "object", "properties": { "mrjCreatedBy": { "type": "string" }, "mrjCreatedDate": { "type": "string", "format": "date-time" }, "mrjCustomerOrganizationID": { "type": "string" }, "mrjUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mrjInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mrjCompleted": { "type": "boolean" }, "mrjConsolidated": { "type": "boolean" }, "mrjDataMissing": { "type": "boolean" }, "mrjDirectLink": { "type": "boolean" }, "mrjExistingJob": { "type": "boolean" }, "mrjFirm": { "type": "boolean" }, "mrjGetPartMethod": { "type": "boolean" }, "mrjIndirectLink": { "type": "boolean" }, "mrjJobAssemblyID": { "type": "integer", "format": "int32" }, "mrjJobDetailID": { "type": "integer", "format": "int32" }, "mrjJobID": { "type": "string" }, "mrjLineID": { "type": "integer", "format": "int32" }, "mrjOrderQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mrjPartBinID": { "type": "string" }, "mrjPartID": { "type": "string" }, "mrjPartPlantID": { "type": "string" }, "mrjPartRevisionID": { "type": "string" }, "mrjPartWarehouseLocationID": { "type": "string" }, "mrjProductionDueDate": { "type": "string", "format": "date-time" }, "mrjRowVersion": { "type": "integer", "format": "int64" }, "mrjSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "mrjSalesOrderID": { "type": "string" }, "mrjSalesOrderLineID": { "type": "integer", "format": "int32" }, "mrjSessionID": { "type": "string" }, "mrjShipLocationID": { "type": "string" }, "mrjShipOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPMRPJobDetailDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMRPJobDetailDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMRPLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMRPLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMRPLineDto": { "required": [ "mrlLineID", "mrlPartID", "mrlSessionID" ], "type": "object", "properties": { "mrlCreatedBy": { "type": "string" }, "mrlCreatedDate": { "type": "string", "format": "date-time" }, "mrlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mrlForecastDemand": { "minimum": 0, "type": "number", "format": "double" }, "mrlInvQtyInProduction": { "minimum": 0, "type": "number", "format": "double" }, "mrlCompleted": { "type": "boolean" }, "mrlDataMissing": { "type": "boolean" }, "mrlLineID": { "type": "integer", "format": "int32" }, "mrlMaximumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mrlMfgLotSize": { "minimum": 0, "type": "number", "format": "double" }, "mrlMinimumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "mrlPartID": { "type": "string" }, "mrlPartRevisionID": { "type": "string" }, "mrlPartShortDescription": { "type": "string" }, "mrlPlantIDs": { "type": "string" }, "mrlQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "mrlQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "mrlQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "mrlRowVersion": { "type": "integer", "format": "int64" }, "mrlSessionID": { "type": "string" }, "mrlWarehouseIDs": { "type": "string" } } }, "ERPResponseMessageDto[ERPMRPLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMRPLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMRPSessionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMRPSessionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMRPSessionDto": { "required": [ "mrpCutoffDate", "mrpSessionID" ], "type": "object", "properties": { "mrpCompletedDate": { "type": "string", "format": "date-time" }, "mrpCreatedBy": { "type": "string" }, "mrpCreatedDate": { "type": "string", "format": "date-time" }, "mrpCustomerIDs": { "type": "string" }, "mrpCutoffDate": { "type": "string", "format": "date-time" }, "mrpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mrpCompleted": { "type": "boolean" }, "mrpConsolidatePartForecastJobs": { "type": "boolean" }, "mrpGenerated": { "type": "boolean" }, "mrpIncludePartForecasts": { "type": "boolean" }, "mrpPartClassIDs": { "type": "string" }, "mrpPartGroupIDs": { "type": "string" }, "mrpPartIDs": { "type": "string" }, "mrpPlantIDs": { "type": "string" }, "mrpRowVersion": { "type": "integer", "format": "int64" }, "mrpSessionID": { "type": "string" }, "mrpWarehouseIDs": { "type": "string" } } }, "ERPResponseMessageDto[ERPMRPSessionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMRPSessionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPMRPSupplyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPMRPSupplyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPMRPSupplyDto": { "required": [ "mrsDueDate", "mrsLineID", "mrsPartBinID", "mrsPartID", "mrsPartWarehouseLocationID", "mrsSessionID", "mrsSupplyID" ], "type": "object", "properties": { "mrsCreatedBy": { "type": "string" }, "mrsCreatedDate": { "type": "string", "format": "date-time" }, "mrsCustomerOrganizationID": { "type": "string" }, "mrsDueDate": { "type": "string", "format": "date-time" }, "mrsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mrsJobAssemblyID": { "type": "integer", "format": "int32" }, "mrsJobID": { "type": "string" }, "mrsLineID": { "type": "integer", "format": "int32" }, "mrsPartBinID": { "type": "string" }, "mrsPartID": { "type": "string" }, "mrsPartRevisionID": { "type": "string" }, "mrsPartWarehouseLocationID": { "type": "string" }, "mrsQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "mrsQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "mrsRowVersion": { "type": "integer", "format": "int64" }, "mrsSessionID": { "type": "string" }, "mrsSource": { "type": "string" }, "mrsSupplyID": { "type": "integer", "format": "int32" }, "mrsType": { "type": "string" } } }, "ERPResponseMessageDto[ERPMRPSupplyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPMRPSupplyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPlantDepartmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPlantDepartmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPlantDepartmentDto": { "required": [ "xavPlantDepartmentID", "xavName", "xavPlantID" ], "type": "object", "properties": { "xavApApGlAccountID": { "type": "string" }, "xavApBankAccountID": { "type": "string" }, "xavApCashGlAccountID": { "type": "string" }, "xavApDiscountGlAccountID": { "type": "string" }, "xavApFreightGlAccountID": { "type": "string" }, "xavArArGlAccountID": { "type": "string" }, "xavArBankAccountID": { "type": "string" }, "xavArCashGlAccountID": { "type": "string" }, "xavArDepositGlAccountID": { "type": "string" }, "xavArDiscountGlAccountID": { "type": "string" }, "xavArFreightGlAccountID": { "type": "string" }, "xavArSalesGlAccountID": { "type": "string" }, "xavPlantDepartmentID": { "type": "string" }, "xavCreatedBy": { "type": "string" }, "xavCreatedDate": { "type": "string", "format": "date-time" }, "xavUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xavEstablishedDate": { "type": "string", "format": "date-time" }, "xavInactiveDate": { "type": "string", "format": "date-time" }, "xavInactive": { "type": "boolean" }, "xavUseProperties": { "type": "boolean" }, "xavName": { "type": "string" }, "xavPlantID": { "type": "string" }, "xavRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPPlantDepartmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPlantDepartmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPlantDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPlantDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPlantDto": { "required": [ "xauPlantID", "xauName" ], "type": "object", "properties": { "xauAccruedCreditorsGlAccountID": { "type": "string" }, "xauAddressLine1": { "type": "string" }, "xauAddressLine2": { "type": "string" }, "xauAddressLine3": { "type": "string" }, "xauApApGlAccountID": { "type": "string" }, "xauApBankAccountID": { "type": "string" }, "xauApCashGlAccountID": { "type": "string" }, "xauApDiscountGlAccountID": { "type": "string" }, "xauApFreightGlAccountID": { "type": "string" }, "xauArArGlAccountID": { "type": "string" }, "xauArBankAccountID": { "type": "string" }, "xauArCashGlAccountID": { "type": "string" }, "xauArDepositGlAccountID": { "type": "string" }, "xauArDiscountGlAccountID": { "type": "string" }, "xauArFreightGlAccountID": { "type": "string" }, "xauArSalesGlAccountID": { "type": "string" }, "xauCity": { "type": "string" }, "xauPlantID": { "type": "string" }, "xauCountry": { "type": "string" }, "xauCountryCode": { "type": "string" }, "xauCreatedBy": { "type": "string" }, "xauCreatedDate": { "type": "string", "format": "date-time" }, "xauDayStartTimeFri": { "minimum": 0, "type": "number", "format": "double" }, "xauDayStartTimeMon": { "minimum": 0, "type": "number", "format": "double" }, "xauDayStartTimeSat": { "minimum": 0, "type": "number", "format": "double" }, "xauDayStartTimeSun": { "minimum": 0, "type": "number", "format": "double" }, "xauDayStartTimeThu": { "minimum": 0, "type": "number", "format": "double" }, "xauDayStartTimeTue": { "minimum": 0, "type": "number", "format": "double" }, "xauDayStartTimeWed": { "minimum": 0, "type": "number", "format": "double" }, "xauEmailAddress": { "type": "string" }, "xauUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xauEstablishedDate": { "type": "string", "format": "date-time" }, "xauFaxNumber": { "type": "string" }, "xauFederalID": { "type": "string" }, "xauHoursFri": { "minimum": 0, "type": "number", "format": "double" }, "xauHoursMon": { "minimum": 0, "type": "number", "format": "double" }, "xauHoursSat": { "minimum": 0, "type": "number", "format": "double" }, "xauHoursSun": { "minimum": 0, "type": "number", "format": "double" }, "xauHoursThu": { "minimum": 0, "type": "number", "format": "double" }, "xauHoursTue": { "minimum": 0, "type": "number", "format": "double" }, "xauHoursWed": { "minimum": 0, "type": "number", "format": "double" }, "xauInactiveDate": { "type": "string", "format": "date-time" }, "xauInactive": { "type": "boolean" }, "xauAvalaraAddressValidated": { "type": "boolean" }, "xauUseProperties": { "type": "boolean" }, "xauLaborClearingGlAccountID": { "type": "string" }, "xauName": { "type": "string" }, "xauOverheadClearingGlAccountID": { "type": "string" }, "xauPhoneNumber": { "type": "string" }, "xauPostCode": { "type": "string" }, "xauPurchaseVarianceGlAccountID": { "type": "string" }, "xauRowVersion": { "type": "integer", "format": "int64" }, "xauShipAwaitInvoiceGlAccountID": { "type": "string" }, "xauState": { "type": "string" }, "xauStockInTransitGlAccountID": { "type": "string" }, "xauStockRevaluationGlAccountID": { "type": "string" }, "xauSVarLaborGlAccountID": { "type": "string" }, "xauSVarMaterialGlAccountID": { "type": "string" }, "xauSVarOverheadGlAccountID": { "type": "string" }, "xauSVarSubcontractGlAccountID": { "type": "string" }, "xauWipLaborGlAccountID": { "type": "string" }, "xauWipMaterialGlAccountID": { "type": "string" }, "xauWipoverheadGlAccountID": { "type": "string" }, "xauWipSubcontractGlAccountID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPlantDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPlantDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPriorityDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPriorityDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPriorityDto": { "required": [ "kbrDescription", "kbrPriorityID" ], "type": "object", "properties": { "kbrCreatedBy": { "type": "string" }, "kbrCreatedDate": { "type": "string", "format": "date-time" }, "kbrDescription": { "type": "string" }, "kbrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbrRowVersion": { "type": "integer", "format": "int64" }, "kbrPriorityID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPPriorityDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPriorityDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProcessDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProcessDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProcessDto": { "required": [ "xacProcessID", "xacShortDescription" ], "type": "object", "properties": { "xacProcessID": { "type": "string" }, "xacCreatedBy": { "type": "string" }, "xacCreatedDate": { "type": "string", "format": "date-time" }, "xacUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xacInactiveDate": { "type": "string", "format": "date-time" }, "xacInspectionType": { "type": "integer", "format": "int32" }, "xacInactive": { "type": "boolean" }, "xacExcludeFromTMJobs": { "type": "boolean" }, "xacIgnoreCalendarMove": { "type": "boolean" }, "xacIgnoreCalendarQueue": { "type": "boolean" }, "xacPrintInspectionLine": { "type": "boolean" }, "xacLongDescriptionRtf": { "type": "string" }, "xacLongDescriptionText": { "type": "string" }, "xacProductionStandard": { "minimum": 0, "type": "number", "format": "double" }, "xacProjectedProductionRate": { "minimum": 0, "type": "number", "format": "double" }, "xacProjectedSetupRate": { "minimum": 0, "type": "number", "format": "double" }, "xacRowVersion": { "type": "integer", "format": "int64" }, "xacSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "xacShortDescription": { "type": "string" }, "xacStandardFactor": { "type": "string" } } }, "ERPResponseMessageDto[ERPProcessDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProcessDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductionCalendarDayDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductionCalendarDayDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProductionCalendarDayDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductionCalendarDayDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductionCalendarDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductionCalendarDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProductionCalendarDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductionCalendarDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductionCalendarWorkCenterDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductionCalendarWorkCenterDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProductionCalendarWorkCenterDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductionCalendarWorkCenterDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProductionDepartmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProductionDepartmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProductionDepartmentDto": { "required": [ "xaeProductionDepartmentID", "xaeDescription" ], "type": "object", "properties": { "xaeProductionDepartmentID": { "type": "string" }, "xaeCreatedBy": { "type": "string" }, "xaeCreatedDate": { "type": "string", "format": "date-time" }, "xaeDescription": { "type": "string" }, "xaeUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xaeRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPProductionDepartmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProductionDepartmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPToolCategoryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPToolCategoryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPToolCategoryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPToolCategoryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPToolMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPToolMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPToolMemoDto": { "required": [ "xtmShortDescription" ], "type": "object", "properties": { "xtmCreatedBy": { "type": "string" }, "xtmCreatedDate": { "type": "string", "format": "date-time" }, "xtmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xtmLongDescriptionRtf": { "type": "string" }, "xtmLongDescriptionText": { "type": "string" }, "xtmMemoDate": { "type": "string", "format": "date-time" }, "xtmRowVersion": { "type": "integer", "format": "int64" }, "xtmToolMemoID": { "type": "integer", "format": "int32" }, "xtmShortDescription": { "type": "string" }, "xtmToolID": { "type": "string" } } }, "ERPResponseMessageDto[ERPToolMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPToolMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPToolMovementDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPToolMovementDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPToolMovementDto": { "required": [ "xtaMovementDate", "xtaMovementType", "xtaToolMovementID", "xtaToolID" ], "type": "object", "properties": { "xtaCheckedOutToEmployeeID": { "type": "string" }, "xtaCheckoutReasonID": { "type": "string" }, "xtaCreatedBy": { "type": "string" }, "xtaCreatedDate": { "type": "string", "format": "date-time" }, "xtaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xtaJobID": { "type": "string" }, "xtaLocation": { "type": "string" }, "xtaMovementDate": { "type": "string", "format": "date-time" }, "xtaMovementType": { "type": "string" }, "xtaNotesRTF": { "type": "string" }, "xtaNotesText": { "type": "string" }, "xtaPlannedReturnDate": { "type": "string", "format": "date-time" }, "xtaPlantDepartmentID": { "type": "string" }, "xtaPlantID": { "type": "string" }, "xtaProductionDepartmentID": { "type": "string" }, "xtaRowVersion": { "type": "integer", "format": "int64" }, "xtaToolMovementID": { "maximum": 999999999, "minimum": 0, "type": "integer", "format": "int32" }, "xtaToolID": { "type": "string" }, "xtaWorkCenterID": { "type": "string" } } }, "ERPResponseMessageDto[ERPToolMovementDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPToolMovementDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPToolDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPToolDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPToolDto": { "required": [ "xttToolID", "xttDescription" ], "type": "object", "properties": { "xttAssetID": { "type": "string" }, "xttCheckedOutToEmployeeID": { "type": "string" }, "xttCheckoutReasonID": { "type": "string" }, "xttToolID": { "type": "string" }, "xttCreatedBy": { "type": "string" }, "xttCreatedDate": { "type": "string", "format": "date-time" }, "xttDescription": { "type": "string" }, "xttDocuments": { "type": "string" }, "xttUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xttIdentificationNumber": { "type": "string" }, "xttInactiveDate": { "type": "string", "format": "date-time" }, "xttInactive": { "type": "boolean" }, "xttLocation": { "type": "string" }, "xttLongDescriptionRtf": { "type": "string" }, "xttLongDescriptionText": { "type": "string" }, "xttMovementDate": { "type": "string", "format": "date-time" }, "xttMovementType": { "type": "string" }, "xttPlannedReturnDate": { "type": "string", "format": "date-time" }, "xttRowVersion": { "type": "integer", "format": "int64" }, "xttToolCategoryID": { "type": "string" }, "xttWorkCenterID": { "type": "string" } } }, "ERPResponseMessageDto[ERPToolDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPToolDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWorkCenterMachineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWorkCenterMachineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWorkCenterMachineDto": { "required": [ "xaqDescription", "xaqWorkCenterMachineID", "xaqWorkCenterID" ], "type": "object", "properties": { "xaqDescription": { "type": "string" }, "xaqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xaqRowVersion": { "type": "integer", "format": "int64" }, "xaqWorkCenterMachineID": { "type": "integer", "format": "int32" }, "xaqWorkCenterID": { "type": "string" } } }, "ERPResponseMessageDto[ERPWorkCenterMachineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWorkCenterMachineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWorkCenterMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWorkCenterMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWorkCenterMemoDto": { "required": [ "xakMemoDate", "xakWorkCenterMemoID", "xakShortDescription", "xakWorkCenterID" ], "type": "object", "properties": { "xakCreatedBy": { "type": "string" }, "xakCreatedDate": { "type": "string", "format": "date-time" }, "xakUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xakLongDescriptionRtf": { "type": "string" }, "xakLongDescriptionText": { "type": "string" }, "xakMemoDate": { "type": "string", "format": "date-time" }, "xakRowVersion": { "type": "integer", "format": "int64" }, "xakWorkCenterMemoID": { "type": "integer", "format": "int32" }, "xakShortDescription": { "type": "string" }, "xakShowInJobs": { "type": "boolean" }, "xakShowInParts": { "type": "boolean" }, "xakShowInQuotes": { "type": "boolean" }, "xakShowInWorkCenters": { "type": "boolean" }, "xakWorkCenterID": { "type": "string" } } }, "ERPResponseMessageDto[ERPWorkCenterMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWorkCenterMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPWorkCenterDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPWorkCenterDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPWorkCenterDto": { "required": [ "xawWorkCenterID", "xawDescription", "xawNumberOfMachines", "xawOverheadCalculationType", "xawPeoplePerMachineProd", "xawPeoplePerMachineSetup", "xawProductionDepartmentID" ], "type": "object", "properties": { "xawCalendarColor": { "type": "integer", "format": "int32" }, "xawCalendarLocation": { "type": "string" }, "xawWorkCenterID": { "type": "string" }, "xawCreatedBy": { "type": "string" }, "xawCreatedDate": { "type": "string", "format": "date-time" }, "xawDayStartTimeFri": { "minimum": 0, "type": "number", "format": "double" }, "xawDayStartTimeMon": { "minimum": 0, "type": "number", "format": "double" }, "xawDayStartTimeSat": { "minimum": 0, "type": "number", "format": "double" }, "xawDayStartTimeSun": { "minimum": 0, "type": "number", "format": "double" }, "xawDayStartTimeThu": { "minimum": 0, "type": "number", "format": "double" }, "xawDayStartTimeTue": { "minimum": 0, "type": "number", "format": "double" }, "xawDayStartTimeWed": { "minimum": 0, "type": "number", "format": "double" }, "xawDescription": { "type": "string" }, "xawUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xawFiniteTolerance": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursFri": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursMon": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursSat": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursSun": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursThu": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursTue": { "minimum": 0, "type": "number", "format": "double" }, "xawHoursWed": { "minimum": 0, "type": "number", "format": "double" }, "xawInactiveDate": { "type": "string", "format": "date-time" }, "xawInactive": { "type": "boolean" }, "xawEnableCalendar": { "type": "boolean" }, "xawExcludeFromShopLoad": { "type": "boolean" }, "xawExportToCalendar": { "type": "boolean" }, "xawInfiniteCapacity": { "type": "boolean" }, "xawOutsideProcessing": { "type": "boolean" }, "xawSetMachineToLaborHours": { "type": "boolean" }, "xawSplitMachineHours": { "type": "boolean" }, "xawMoveTime": { "minimum": 0, "type": "number", "format": "double" }, "xawNumberOfMachines": { "type": "integer", "format": "int32" }, "xawOverheadCalculationType": { "type": "integer", "format": "int32" }, "xawOverheadRate": { "minimum": 0, "type": "number", "format": "double" }, "xawPeoplePerMachineProd": { "type": "integer", "format": "int32" }, "xawPeoplePerMachineSetup": { "type": "integer", "format": "int32" }, "xawPlantID": { "type": "string" }, "xawProcessID": { "type": "string" }, "xawProductionDepartmentID": { "type": "string" }, "xawProductionStandard": { "minimum": 0, "type": "number", "format": "double" }, "xawQueueTime": { "minimum": 0, "type": "number", "format": "double" }, "xawQuotingRate": { "minimum": 0, "type": "number", "format": "double" }, "xawRowVersion": { "type": "integer", "format": "int64" }, "xawSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "xawStandardFactor": { "type": "string" }, "xawStartHour": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPWorkCenterDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPWorkCenterDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProjectAreaDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProjectAreaDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProjectAreaDto": { "required": [ "praProjectAreaID", "praDescription", "praProjectID" ], "type": "object", "properties": { "praProjectAreaID": { "type": "string" }, "praCreatedBy": { "type": "string" }, "praCreatedDate": { "type": "string", "format": "date-time" }, "praDescription": { "type": "string" }, "praUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "praProjectID": { "type": "string" }, "praRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPProjectAreaDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProjectAreaDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProjectContactDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProjectContactDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProjectContactDto": { "required": [ "prcContactID", "prcOrganizationID", "prcProjectID", "prcProjectContactID" ], "type": "object", "properties": { "prcContactID": { "type": "string" }, "prcContactTitleID": { "type": "string" }, "prcCreatedBy": { "type": "string" }, "prcCreatedDate": { "type": "string", "format": "date-time" }, "prcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "prcLocationID": { "type": "string" }, "prcNotesRTF": { "type": "string" }, "prcNotesText": { "type": "string" }, "prcOrganizationID": { "type": "string" }, "prcProjectID": { "type": "string" }, "prcRowVersion": { "type": "integer", "format": "int64" }, "prcProjectContactID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPProjectContactDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProjectContactDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProjectDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProjectDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProjectDto": { "required": [ "prpProjectID", "prpProjectDate", "prpShortDescription" ], "type": "object", "properties": { "prpClosedDate": { "type": "string", "format": "date-time" }, "prpProjectID": { "type": "string" }, "prpContactID": { "type": "string" }, "prpCreatedBy": { "type": "string" }, "prpCreatedDate": { "type": "string", "format": "date-time" }, "prpDueDate": { "type": "string", "format": "date-time" }, "prpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "prpClosed": { "type": "boolean" }, "prpLocationID": { "type": "string" }, "prpLongDescriptionRtf": { "type": "string" }, "prpLongDescriptionText": { "type": "string" }, "prpOrganizationID": { "type": "string" }, "prpProjectDate": { "type": "string", "format": "date-time" }, "prpProjectManagerEmployeeID": { "type": "string" }, "prpProjectTypeID": { "type": "string" }, "prpRowVersion": { "type": "integer", "format": "int64" }, "prpShortDescription": { "type": "string" }, "prpStatus": { "type": "string" } } }, "ERPResponseMessageDto[ERPProjectDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProjectDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPProjectTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPProjectTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPProjectTypeDto": { "required": [ "prtProjectTypeID", "prtDescription" ], "type": "object", "properties": { "prtProjectTypeID": { "type": "string" }, "prtCreatedBy": { "type": "string" }, "prtCreatedDate": { "type": "string", "format": "date-time" }, "prtDescription": { "type": "string" }, "prtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "prtInactiveDate": { "type": "string", "format": "date-time" }, "prtInactive": { "type": "boolean" }, "prtRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPProjectTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPProjectTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderAccountDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderAccountDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderAccountDto": { "required": [ "pmxExpenseGlAccountID", "pmxPurchaseOrderID", "pmxPurchaseOrderLineID", "pmxPurchaseOrderAccountID" ], "type": "object", "properties": { "pmxAmount": { "minimum": 0, "type": "number", "format": "double" }, "pmxCreatedBy": { "type": "string" }, "pmxCreatedDate": { "type": "string", "format": "date-time" }, "pmxUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmxExpenseGlAccountID": { "type": "string" }, "pmxClosed": { "type": "boolean" }, "pmxPercent": { "minimum": 0, "type": "number", "format": "double" }, "pmxPurchaseOrderID": { "type": "string" }, "pmxPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "pmxRowVersion": { "type": "integer", "format": "int64" }, "pmxPurchaseOrderAccountID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPPurchaseOrderAccountDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderAccountDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderApprovalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderApprovalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderApprovalDto": { "required": [ "pmaPurchaseOrderID", "pmaPurchaseOrderApprovalID" ], "type": "object", "properties": { "pmaApprovalEmployeeID": { "type": "string" }, "pmaCreatedBy": { "type": "string" }, "pmaCreatedDate": { "type": "string", "format": "date-time" }, "pmaDescription": { "type": "string" }, "pmaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmaPurchaseOrderID": { "type": "string" }, "pmaRowVersion": { "type": "integer", "format": "int64" }, "pmaPurchaseOrderApprovalID": { "type": "integer", "format": "int32" }, "pmaStatus": { "type": "integer", "format": "int32" }, "pmaStatusDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPPurchaseOrderApprovalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderApprovalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderComponentDto": { "required": [ "pmoDeliveryQuantity", "pmoDescription", "pmoPartBinID", "pmoPartID", "pmoPartWarehouseLocationID", "pmoPurchaseOrderID", "pmoPurchaseOrderLineID", "pmoPurchaseOrderComponentID" ], "type": "object", "properties": { "pmoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmoCreatedBy": { "type": "string" }, "pmoCreatedDate": { "type": "string", "format": "date-time" }, "pmoDeliveryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmoDescription": { "type": "string" }, "pmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmoExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "pmoExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmoClosed": { "type": "boolean" }, "pmoIntraCompanyPosted": { "type": "boolean" }, "pmoReceivedComplete": { "type": "boolean" }, "pmoJobAssemblyID": { "type": "integer", "format": "int32" }, "pmoJobID": { "type": "string" }, "pmoJobMaterialComponentID": { "type": "integer", "format": "int32" }, "pmoJobMaterialID": { "type": "integer", "format": "int32" }, "pmoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmoPartBinID": { "type": "string" }, "pmoPartID": { "type": "string" }, "pmoPartRevisionID": { "type": "string" }, "pmoPartWarehouseLocationID": { "type": "string" }, "pmoPurchaseOrderID": { "type": "string" }, "pmoPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "pmoPurchaseUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "pmoPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "pmoQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "pmoRowVersion": { "type": "integer", "format": "int64" }, "pmoPurchaseOrderComponentID": { "type": "integer", "format": "int32" }, "pmoUnitOfMeasure": { "type": "string" }, "pmoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPurchaseOrderComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderDeliveryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderDeliveryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderDeliveryDto": { "required": [ "pmdDeliveryDate", "pmdDeliveryType", "pmdPurchaseOrderID", "pmdPurchaseOrderLineID", "pmdPurchaseOrderDeliveryID" ], "type": "object", "properties": { "pmdContactID": { "type": "string" }, "pmdCreatedBy": { "type": "string" }, "pmdCreatedDate": { "type": "string", "format": "date-time" }, "pmdDeliveryDate": { "type": "string", "format": "date-time" }, "pmdDeliveryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmdDeliveryType": { "type": "integer", "format": "int32" }, "pmdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmdClosed": { "type": "boolean" }, "pmdInTransit": { "type": "boolean" }, "pmdInvoicedComplete": { "type": "boolean" }, "pmdReceivedComplete": { "type": "boolean" }, "pmdJobAssemblyID": { "type": "integer", "format": "int32" }, "pmdJobID": { "type": "string" }, "pmdJobMaterialID": { "type": "integer", "format": "int32" }, "pmdJobOperationID": { "type": "integer", "format": "int32" }, "pmdJobType": { "type": "integer", "format": "int32" }, "pmdLocationID": { "type": "string" }, "pmdOrganizationID": { "type": "string" }, "pmdPurchaseOrderID": { "type": "string" }, "pmdPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "pmdQuantityInvoiced": { "minimum": 0, "type": "number", "format": "double" }, "pmdQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "pmdRowVersion": { "type": "integer", "format": "int64" }, "pmdPurchaseOrderDeliveryID": { "type": "integer", "format": "int32" }, "pmdShippingMethodID": { "type": "string" }, "pmdTrackingNumber": { "type": "string" } } }, "ERPResponseMessageDto[ERPPurchaseOrderDeliveryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderDeliveryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderLineDto": { "required": [ "pmlDueDate", "pmlPurchaseOrderID", "pmlPurchaseType", "pmlPurchaseOrderLineID" ], "type": "object", "properties": { "pmlAssetID": { "type": "string" }, "pmlAssetTypeID": { "type": "string" }, "pmlConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "pmlCreatedBy": { "type": "string" }, "pmlCreatedDate": { "type": "string", "format": "date-time" }, "pmlDmrClaimID": { "type": "string" }, "pmlDmrClaimLineID": { "type": "integer", "format": "int32" }, "pmlDocuments": { "type": "string" }, "pmlDueDate": { "type": "string", "format": "date-time" }, "pmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmlExpenseSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "pmlExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "pmlExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmlForm1099Box": { "type": "integer", "format": "int32" }, "pmlInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmlInventoryQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "pmlInventoryUnitOfMeasure": { "type": "string" }, "pmlClosed": { "type": "boolean" }, "pmlCreateJobSeq": { "type": "boolean" }, "pmlIntraCompanyPosted": { "type": "boolean" }, "pmlInTransit": { "type": "boolean" }, "pmlInTransitJournalsCreated": { "type": "boolean" }, "pmlInvoicedComplete": { "type": "boolean" }, "pmlKitPart": { "type": "boolean" }, "pmlPlanned": { "type": "boolean" }, "pmlPriceOverride": { "type": "boolean" }, "pmlReceivedComplete": { "type": "boolean" }, "pmlRequiresInspection": { "type": "boolean" }, "pmlSupplierRequirement": { "type": "boolean" }, "pmlTaxable": { "type": "boolean" }, "pmlItemType": { "type": "string" }, "pmlJobAssemblyID": { "type": "integer", "format": "int32" }, "pmlJobID": { "type": "string" }, "pmlJobMaterialID": { "type": "integer", "format": "int32" }, "pmlJobOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmlJobOperationID": { "type": "integer", "format": "int32" }, "pmlJobType": { "type": "integer", "format": "int32" }, "pmlLandedCostID": { "type": "string" }, "pmlLeadTime": { "type": "integer", "format": "int32" }, "pmlNonTaxReasonID": { "type": "string" }, "pmlOrgPartID": { "type": "string" }, "pmlOrgPartShortDescription": { "type": "string" }, "pmlPartBinID": { "type": "string" }, "pmlPartID": { "type": "string" }, "pmlPartLongDescriptionRtf": { "type": "string" }, "pmlPartLongDescriptionText": { "type": "string" }, "pmlPartRevisionID": { "type": "string" }, "pmlPartShortDescription": { "type": "string" }, "pmlPartWarehouseLocationID": { "type": "string" }, "pmlProcessID": { "type": "string" }, "pmlProjectAreaID": { "type": "string" }, "pmlProjectID": { "type": "string" }, "pmlPurchaseOrderID": { "type": "string" }, "pmlPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pmlPurchaseQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "pmlPurchaseType": { "type": "integer", "format": "int32" }, "pmlPurchaseUnitCostBase": { "minimum": 0, "type": "number", "format": "double" }, "pmlPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmlPurchaseUnitOfMeasure": { "type": "string" }, "pmlQuantityOnOrder": { "minimum": 0, "type": "number", "format": "double" }, "pmlRfqID": { "type": "string" }, "pmlRfqLineID": { "type": "integer", "format": "int32" }, "pmlRmaClaimID": { "type": "string" }, "pmlRmaClaimLineID": { "type": "integer", "format": "int32" }, "pmlRowVersion": { "type": "integer", "format": "int64" }, "pmlSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "pmlSalesOrderID": { "type": "string" }, "pmlSalesOrderLineID": { "type": "integer", "format": "int32" }, "pmlSecondTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "pmlSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmlSecondTaxCodeID": { "type": "string" }, "pmlPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "pmlSetupChargeBase": { "minimum": 0, "type": "number", "format": "double" }, "pmlSetupChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmlSourcePurchaseOrderID": { "type": "string" }, "pmlSourcePurchaseOrderLineID": { "type": "integer", "format": "int32" }, "pmlSourceTableName": { "type": "string" }, "pmlSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmlTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "pmlTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmlTaxCodeID": { "type": "string" }, "pmlTotalComponentCosts": { "minimum": 0, "type": "number", "format": "double" }, "pmlTotalExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "pmlTotalExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmlTrackingNumber": { "type": "string" }, "pmlWorkCenterID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPurchaseOrderLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderMemoDto": { "required": [ "pmkMemoDate", "pmkPurchaseOrderID", "pmkPurchaseOrderMemoID", "pmkShortDescription" ], "type": "object", "properties": { "pmkCreatedBy": { "type": "string" }, "pmkCreatedDate": { "type": "string", "format": "date-time" }, "pmkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmkClosed": { "type": "boolean" }, "pmkLongDescriptionRtf": { "type": "string" }, "pmkLongDescriptionText": { "type": "string" }, "pmkMemoDate": { "type": "string", "format": "date-time" }, "pmkPurchaseOrderID": { "type": "string" }, "pmkRowVersion": { "type": "integer", "format": "int64" }, "pmkPurchaseOrderMemoID": { "type": "integer", "format": "int32" }, "pmkShortDescription": { "type": "string" }, "pmkShowInApInvoices": { "type": "boolean" }, "pmkShowInPurchaseOrders": { "type": "boolean" }, "pmkShowInReceipts": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPPurchaseOrderMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchaseOrderDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchaseOrderDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchaseOrderDto": { "required": [ "pmpPurchaseOrderID", "pmpOrderDate", "pmpStatus", "pmpSupplierOrganizationID" ], "type": "object", "properties": { "pmpApInvoiceContactID": { "type": "string" }, "pmpApInvoiceLocationID": { "type": "string" }, "pmpApprovalDecisionDate": { "type": "string", "format": "date-time" }, "pmpApprovalRequestDate": { "type": "string", "format": "date-time" }, "pmpBuyerEmployeeID": { "type": "string" }, "pmpClosedDate": { "type": "string", "format": "date-time" }, "pmpPurchaseOrderID": { "type": "string" }, "pmpCreatedBy": { "type": "string" }, "pmpCreatedDate": { "type": "string", "format": "date-time" }, "pmpCurrencyRateID": { "type": "string" }, "pmpDocuments": { "type": "string" }, "pmpDropShipContactID": { "type": "string" }, "pmpDropShipLocationID": { "type": "string" }, "pmpDropShipOrganizationID": { "type": "string" }, "pmpDueDate": { "type": "string", "format": "date-time" }, "pmpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pmpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "pmpFreeOnBoardDescription": { "type": "string" }, "pmpIntraCompanyPostedDate": { "type": "string", "format": "date-time" }, "pmpClosed": { "type": "boolean" }, "pmpCustomRate": { "type": "boolean" }, "pmpIntraCompany": { "type": "boolean" }, "pmpIntraCompanyPosted": { "type": "boolean" }, "pmpReadyToPrint": { "type": "boolean" }, "pmpNextApprovalEmployeeID": { "type": "string" }, "pmpOrderCommentsRTF": { "type": "string" }, "pmpOrderCommentsText": { "type": "string" }, "pmpOrderDate": { "type": "string", "format": "date-time" }, "pmpOrderSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "pmpOrderSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmpOrderTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "pmpOrderTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmpOrderTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "pmpOrderTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "pmpPaymentTermID": { "type": "string" }, "pmpPlantDepartmentID": { "type": "string" }, "pmpPlantID": { "type": "string" }, "pmpProjectID": { "type": "string" }, "pmpPurchaseContactID": { "type": "string" }, "pmpPurchaseLocationID": { "type": "string" }, "pmpRowVersion": { "type": "integer", "format": "int64" }, "pmpShippingMethodID": { "type": "string" }, "pmpStandardMessageID": { "type": "string" }, "pmpStatus": { "type": "integer", "format": "int32" }, "pmpSupplierOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPurchaseOrderDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchaseOrderDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchasePlannerLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchasePlannerLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchasePlannerLineDto": { "required": [ "pplLineID", "pplSessionID" ], "type": "object", "properties": { "pplCreatedBy": { "type": "string" }, "pplCreatedDate": { "type": "string", "format": "date-time" }, "pplDataMissing": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "pplUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pplExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "pplCompleted": { "type": "boolean" }, "pplNonStockedItem": { "type": "boolean" }, "pplPhantomOrKitPart": { "type": "boolean" }, "pplLastRunDate": { "type": "string", "format": "date-time" }, "pplLineID": { "type": "integer", "format": "int32" }, "pplLotSize": { "minimum": 0, "type": "number", "format": "double" }, "pplMaximumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pplMinimumQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pplPartID": { "type": "string" }, "pplPartRevisionID": { "type": "string" }, "pplPartShortDescription": { "type": "string" }, "pplPlantID": { "type": "string" }, "pplQuantityOnHand": { "minimum": 0, "type": "number", "format": "double" }, "pplReorderMethod": { "type": "integer", "format": "int32" }, "pplRowVersion": { "type": "integer", "format": "int64" }, "pplSessionID": { "type": "string" }, "pplWarehouseID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPurchasePlannerLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchasePlannerLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchasePlannerOrderDetailDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchasePlannerOrderDetailDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchasePlannerOrderDetailDto": { "required": [ "ppoLineID", "ppoOrderDetailID", "ppoPartBinID", "ppoPartID", "ppoPartWarehouseLocationID", "ppoSessionID", "ppoSupplierOrganizationID" ], "type": "object", "properties": { "ppoConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "ppoCreatedBy": { "type": "string" }, "ppoCreatedDate": { "type": "string", "format": "date-time" }, "ppoCurrencyRateID": { "type": "string" }, "ppoDataMissing": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "ppoDueDate": { "type": "string", "format": "date-time" }, "ppoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ppoExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "ppoInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "ppoInventoryUnitOfMeasure": { "type": "string" }, "ppoCompleted": { "type": "boolean" }, "ppoSupplierRequirement": { "type": "boolean" }, "ppoJobAssemblyID": { "type": "integer", "format": "int32" }, "ppoJobID": { "type": "string" }, "ppoJobMaterialID": { "type": "integer", "format": "int32" }, "ppoLeadTime": { "type": "integer", "format": "int32" }, "ppoLineID": { "type": "integer", "format": "int32" }, "ppoOrderDetailID": { "type": "integer", "format": "int32" }, "ppoPartBinID": { "type": "string" }, "ppoPartID": { "type": "string" }, "ppoPartRevisionID": { "type": "string" }, "ppoPartWarehouseLocationID": { "type": "string" }, "ppoProjectAreaID": { "type": "string" }, "ppoProjectID": { "type": "string" }, "ppoPurchaseLocationID": { "type": "string" }, "ppoPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "ppoPurchaseType": { "type": "integer", "format": "int32" }, "ppoPurchaseUnitOfMeasure": { "type": "string" }, "ppoRowVersion": { "type": "integer", "format": "int64" }, "ppoSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "ppoSalesOrderID": { "type": "string" }, "ppoSalesOrderLineID": { "type": "integer", "format": "int32" }, "ppoSessionID": { "type": "string" }, "ppoSupplierOrganizationID": { "type": "string" }, "ppoUnitCostBase": { "minimum": 0, "type": "number", "format": "double" }, "ppoUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPPurchasePlannerOrderDetailDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchasePlannerOrderDetailDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchasePlannerRequirementDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchasePlannerRequirementDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchasePlannerRequirementDto": { "required": [ "pprLineID", "pprRequirementID", "pprSessionID" ], "type": "object", "properties": { "pprCreatedBy": { "type": "string" }, "pprCreatedDate": { "type": "string", "format": "date-time" }, "pprDueDate": { "type": "string", "format": "date-time" }, "pprUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "pprJobAssemblyID": { "type": "integer", "format": "int32" }, "pprJobID": { "type": "string" }, "pprJobMaterialID": { "type": "integer", "format": "int32" }, "pprLineID": { "type": "integer", "format": "int32" }, "pprPlannedReceiptQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pprPlannedRequirementQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pprProjectedBalance": { "minimum": 0, "type": "number", "format": "double" }, "pprPullFromStockQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pprPurchaseOrderDate": { "type": "string", "format": "date-time" }, "pprPurchaseOrderID": { "type": "string" }, "pprPurchaseToJobQuantity": { "minimum": 0, "type": "number", "format": "double" }, "pprPurchaseType": { "type": "integer", "format": "int32" }, "pprRequirementID": { "type": "integer", "format": "int32" }, "pprRowVersion": { "type": "integer", "format": "int64" }, "pprSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "pprSalesOrderID": { "type": "string" }, "pprSalesOrderLineID": { "type": "integer", "format": "int32" }, "pprSessionID": { "type": "string" }, "pprSource": { "type": "string" } } }, "ERPResponseMessageDto[ERPPurchasePlannerRequirementDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchasePlannerRequirementDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPPurchasePlannerSessionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPPurchasePlannerSessionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPPurchasePlannerSessionDto": { "required": [ "ppsBuyerEmployeeID", "ppsCutoffDate", "ppsSessionID" ], "type": "object", "properties": { "ppsBuyerEmployeeID": { "type": "string" }, "ppsCompletedDate": { "type": "string", "format": "date-time" }, "ppsCreatedBy": { "type": "string" }, "ppsCreatedDate": { "type": "string", "format": "date-time" }, "ppsCutoffDate": { "type": "string", "format": "date-time" }, "ppsCutoffDatePosupply": { "type": "string", "format": "date-time" }, "ppsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ppsCalculateForAllParts": { "type": "boolean" }, "ppsCompleted": { "type": "boolean" }, "ppsFirmOnly": { "type": "boolean" }, "ppsGenerated": { "type": "boolean" }, "ppsJobIDs": { "type": "string" }, "ppsPartClassIDs": { "type": "string" }, "ppsPartIDs": { "type": "string" }, "ppsPlantID": { "type": "string" }, "ppsRowVersion": { "type": "integer", "format": "int64" }, "ppsSalesOrderIDs": { "type": "string" }, "ppsSessionID": { "type": "string" }, "ppsSessionSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ppsShowAllDemandForPartsOnJobs": { "type": "boolean" }, "ppsSupplierIDs": { "type": "string" }, "ppsWarehouseID": { "type": "string" } } }, "ERPResponseMessageDto[ERPPurchasePlannerSessionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPPurchasePlannerSessionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRFQLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRFQLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRFQLineDto": { "required": [ "rqlPartID", "rqlPartShortDescription", "rqlPurchaseUnitOfMeasure", "rqlRfqID", "rqlRfqLineID" ], "type": "object", "properties": { "rqlCreatedBy": { "type": "string" }, "rqlCreatedDate": { "type": "string", "format": "date-time" }, "rqlDocuments": { "type": "string" }, "rqlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rqlInventoryUnitOfMeasure": { "type": "string" }, "rqlAlternatePart": { "type": "boolean" }, "rqlClosed": { "type": "boolean" }, "rqlJobAssemblyID": { "type": "integer", "format": "int32" }, "rqlJobEstimatedQty": { "minimum": 0, "type": "number", "format": "double" }, "rqlJobID": { "type": "string" }, "rqlJobMaterialID": { "type": "integer", "format": "int32" }, "rqlJobOperationID": { "type": "integer", "format": "int32" }, "rqlPartID": { "type": "string" }, "rqlPartLongDescriptionRtf": { "type": "string" }, "rqlPartLongDescriptionText": { "type": "string" }, "rqlPartRevisionID": { "type": "string" }, "rqlPartShortDescription": { "type": "string" }, "rqlProjectAreaID": { "type": "string" }, "rqlProjectID": { "type": "string" }, "rqlPurchaseUnitOfMeasure": { "type": "string" }, "rqlQuoteAssemblyID": { "type": "integer", "format": "int32" }, "rqlQuoteID": { "type": "string" }, "rqlQuoteLineID": { "type": "integer", "format": "int32" }, "rqlQuoteMaterialID": { "type": "integer", "format": "int32" }, "rqlQuoteOperationID": { "type": "integer", "format": "int32" }, "rqlRfqID": { "type": "string" }, "rqlRfqType": { "type": "integer", "format": "int32" }, "rqlRowVersion": { "type": "integer", "format": "int64" }, "rqlRfqLineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPRFQLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRFQLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRFQMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRFQMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRFQMemoDto": { "required": [ "rqkMemoDate", "rqkRfqID", "rqkRfqMemoID", "rqkShortDescription" ], "type": "object", "properties": { "rqkCreatedBy": { "type": "string" }, "rqkCreatedDate": { "type": "string", "format": "date-time" }, "rqkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rqkClosed": { "type": "boolean" }, "rqkLongDescriptionRtf": { "type": "string" }, "rqkLongDescriptionText": { "type": "string" }, "rqkMemoDate": { "type": "string", "format": "date-time" }, "rqkRfqID": { "type": "string" }, "rqkRowVersion": { "type": "integer", "format": "int64" }, "rqkRfqMemoID": { "type": "integer", "format": "int32" }, "rqkShortDescription": { "type": "string" } } }, "ERPResponseMessageDto[ERPRFQMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRFQMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRFQQuantityDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRFQQuantityDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRFQQuantityDto": { "required": [ "rqqRfqID", "rqqRfqLineID", "rqqRfqSupplierID", "rqqRfqQuantityID" ], "type": "object", "properties": { "rqqCreatedBy": { "type": "string" }, "rqqCreatedDate": { "type": "string", "format": "date-time" }, "rqqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rqqClosed": { "type": "boolean" }, "rqqLeadTime": { "type": "integer", "format": "int32" }, "rqqPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "rqqPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "rqqQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rqqRfqID": { "type": "string" }, "rqqRfqLineID": { "type": "integer", "format": "int32" }, "rqqRfqSupplierID": { "type": "integer", "format": "int32" }, "rqqRowVersion": { "type": "integer", "format": "int64" }, "rqqRfqQuantityID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPRFQQuantityDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRFQQuantityDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRFQDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRFQDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRFQDto": { "required": [ "rqpRfqID" ], "type": "object", "properties": { "rqpBuyerEmployeeID": { "type": "string" }, "rqpClosedDate": { "type": "string", "format": "date-time" }, "rqpRfqID": { "type": "string" }, "rqpCreatedBy": { "type": "string" }, "rqpCreatedDate": { "type": "string", "format": "date-time" }, "rqpDueDate": { "type": "string", "format": "date-time" }, "rqpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rqpClosed": { "type": "boolean" }, "rqpReadyToPrint": { "type": "boolean" }, "rqpPlantDepartmentID": { "type": "string" }, "rqpPlantID": { "type": "string" }, "rqpRfqDate": { "type": "string", "format": "date-time" }, "rqpRowVersion": { "type": "integer", "format": "int64" }, "rqpStandardMessageID": { "type": "string" } } }, "ERPResponseMessageDto[ERPRFQDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRFQDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRFQSupplierDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRFQSupplierDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRFQSupplierDto": { "required": [ "rqsRfqID", "rqsRfqLineID", "rqsRfqSupplierID", "rqsSupplierOrganizationID" ], "type": "object", "properties": { "rqsCreatedBy": { "type": "string" }, "rqsCreatedDate": { "type": "string", "format": "date-time" }, "rqsCurrencyRateID": { "type": "string" }, "rqsDueDate": { "type": "string", "format": "date-time" }, "rqsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rqsExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "rqsClosed": { "type": "boolean" }, "rqsComplete": { "type": "boolean" }, "rqsCustomRate": { "type": "boolean" }, "rqsSelectedSupplier": { "type": "boolean" }, "rqsUpdatedPartPrices": { "type": "boolean" }, "rqsOrgPartID": { "type": "string" }, "rqsPurchaseContactID": { "type": "string" }, "rqsPurchaseLocationID": { "type": "string" }, "rqsRfqID": { "type": "string" }, "rqsRfqLineID": { "type": "integer", "format": "int32" }, "rqsRowVersion": { "type": "integer", "format": "int64" }, "rqsSelectedSupplierDate": { "type": "string", "format": "date-time" }, "rqsRfqSupplierID": { "type": "integer", "format": "int32" }, "rqsSupplierOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPRFQSupplierDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRFQSupplierDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPReceiptComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPReceiptComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPReceiptComponentDto": { "required": [ "rmoPartBinID", "rmoPartID", "rmoPartWarehouseLocationID", "rmoReceiptID", "rmoReceiptLineID", "rmoReceiptComponentID" ], "type": "object", "properties": { "rmoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmoConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "rmoCreatedBy": { "type": "string" }, "rmoCreatedDate": { "type": "string", "format": "date-time" }, "rmoDescription": { "type": "string" }, "rmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmoExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "rmoExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmoInspParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmoInventoryUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmoInventoryUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmoInvParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmoInvQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmoClosed": { "type": "boolean" }, "rmoInspectionComplete": { "type": "boolean" }, "rmoJobReceivedComplete": { "type": "boolean" }, "rmoPostedToGl": { "type": "boolean" }, "rmoReceivedComplete": { "type": "boolean" }, "rmoReversed": { "type": "boolean" }, "rmoJobAssemblyID": { "type": "integer", "format": "int32" }, "rmoJobID": { "type": "string" }, "rmoJobMaterialComponentID": { "type": "integer", "format": "int32" }, "rmoJobMaterialID": { "type": "integer", "format": "int32" }, "rmoJobParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmoJobQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmoPartBinID": { "type": "string" }, "rmoPartID": { "type": "string" }, "rmoPartRevisionID": { "type": "string" }, "rmoPartWarehouseLocationID": { "type": "string" }, "rmoPurchaseOrderComponentID": { "type": "integer", "format": "int32" }, "rmoPurchaseOrderID": { "type": "string" }, "rmoPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "rmoPurchaseUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmoPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "rmoQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "rmoReceiptID": { "type": "string" }, "rmoReceiptLineID": { "type": "integer", "format": "int32" }, "rmoReverseReceiptComponentID": { "type": "integer", "format": "int32" }, "rmoReverseReceiptID": { "type": "string" }, "rmoReverseReceiptLineID": { "type": "integer", "format": "int32" }, "rmoRowVersion": { "type": "integer", "format": "int64" }, "rmoReceiptComponentID": { "type": "integer", "format": "int32" }, "rmoUnitOfMeasure": { "type": "string" }, "rmoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPReceiptComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPReceiptComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPReceiptLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPReceiptLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPReceiptLineDto": { "required": [ "rmlReceiptID", "rmlReceiptLineID" ], "type": "object", "properties": { "rmlConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "rmlCreatedBy": { "type": "string" }, "rmlCreatedDate": { "type": "string", "format": "date-time" }, "rmlDescription": { "type": "string" }, "rmlDmrClaimID": { "type": "string" }, "rmlDmrClaimLineID": { "type": "integer", "format": "int32" }, "rmlDutyUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmlExtendedCostBase": { "minimum": 0, "type": "number", "format": "double" }, "rmlExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmlForm1099Box": { "type": "integer", "format": "int32" }, "rmlFreightUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmlHeatLot": { "type": "string" }, "rmlInspectionNotesRTF": { "type": "string" }, "rmlInspectionNotesText": { "type": "string" }, "rmlInventoryQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmlInventoryUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmlInventoryUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmlInventoryUnitOfMeasure": { "type": "string" }, "rmlClosed": { "type": "boolean" }, "rmlInInspection": { "type": "boolean" }, "rmlInspectionComplete": { "type": "boolean" }, "rmlInvoicedComplete": { "type": "boolean" }, "rmlJobReceivedComplete": { "type": "boolean" }, "rmlKitPart": { "type": "boolean" }, "rmlPoReceivedComplete": { "type": "boolean" }, "rmlPostedToGl": { "type": "boolean" }, "rmlRequiresInspection": { "type": "boolean" }, "rmlReversed": { "type": "boolean" }, "rmlTrackSerialNumbers": { "type": "boolean" }, "rmlJobAssemblyID": { "type": "integer", "format": "int32" }, "rmlJobEstimatedQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmlJobID": { "type": "string" }, "rmlJobMaterialID": { "type": "integer", "format": "int32" }, "rmlJobMatQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmlJobOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmlJobOperationID": { "type": "integer", "format": "int32" }, "rmlJobOprQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmlJobType": { "type": "integer", "format": "int32" }, "rmlMiscUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmlOrgPartID": { "type": "string" }, "rmlOrgPartShortDescription": { "type": "string" }, "rmlPartBinID": { "type": "string" }, "rmlPartID": { "type": "string" }, "rmlPartLongDescriptionRtf": { "type": "string" }, "rmlPartLongDescriptionText": { "type": "string" }, "rmlPartRevisionID": { "type": "string" }, "rmlPartWarehouseLocationID": { "type": "string" }, "rmlPoOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmlPoPurchaseQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rmlProjectAreaID": { "type": "string" }, "rmlProjectID": { "type": "string" }, "rmlPurchaseOrderID": { "type": "string" }, "rmlPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "rmlPurchaseQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rmlPurchaseUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rmlPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmlPurchaseUnitOfMeasure": { "type": "string" }, "rmlQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "rmlReceiptID": { "type": "string" }, "rmlReference": { "type": "string" }, "rmlReverseReceiptID": { "type": "string" }, "rmlReverseReceiptLineID": { "type": "integer", "format": "int32" }, "rmlRmaClaimID": { "type": "string" }, "rmlRmaClaimLineID": { "type": "integer", "format": "int32" }, "rmlRowVersion": { "type": "integer", "format": "int64" }, "rmlSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "rmlSalesOrderID": { "type": "string" }, "rmlSalesOrderLineID": { "type": "integer", "format": "int32" }, "rmlReceiptLineID": { "type": "integer", "format": "int32" }, "rmlSetupCharge": { "minimum": 0, "type": "number", "format": "double" }, "rmlSetupChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmlTotalComponentCosts": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPReceiptLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPReceiptLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPReceiptDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPReceiptDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPReceiptDto": { "required": [ "rmpReceiptID", "rmpReceiptDate", "rmpSupplierOrganizationID" ], "type": "object", "properties": { "rmpApInvoiceContactID": { "type": "string" }, "rmpApInvoiceLocationID": { "type": "string" }, "rmpClosedDate": { "type": "string", "format": "date-time" }, "rmpReceiptID": { "type": "string" }, "rmpCreatedBy": { "type": "string" }, "rmpCreatedDate": { "type": "string", "format": "date-time" }, "rmpCurrencyRateID": { "type": "string" }, "rmpDeliveryDocket": { "type": "string" }, "rmpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "rmpFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "rmpFreightChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmpClosed": { "type": "boolean" }, "rmpCustomRate": { "type": "boolean" }, "rmpFlaggedForWMS": { "type": "boolean" }, "rmpNestlinkProcessed": { "type": "boolean" }, "rmpPostedToGl": { "type": "boolean" }, "rmpReversalEntry": { "type": "boolean" }, "rmpReversed": { "type": "boolean" }, "rmpLandedCostID": { "type": "string" }, "rmpPlantDepartmentID": { "type": "string" }, "rmpPlantID": { "type": "string" }, "rmpPostedDate": { "type": "string", "format": "date-time" }, "rmpProjectID": { "type": "string" }, "rmpPurchaseContactID": { "type": "string" }, "rmpPurchaseLocationID": { "type": "string" }, "rmpReceiptDate": { "type": "string", "format": "date-time" }, "rmpReceiptSubtotal": { "minimum": 0, "type": "number", "format": "double" }, "rmpReceiptSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmpReceiptTotal": { "minimum": 0, "type": "number", "format": "double" }, "rmpReceiptTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "rmpRowVersion": { "type": "integer", "format": "int64" }, "rmpShippingMethodID": { "type": "string" }, "rmpSupplierOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPReceiptDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPReceiptDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCorrectiveActionCategoryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCorrectiveActionCategoryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCorrectiveActionCategoryDto": { "required": [ "qatCorrectiveActionCategoryID", "qatDescription" ], "type": "object", "properties": { "qatCorrectiveActionCategoryID": { "type": "string" }, "qatCreatedBy": { "type": "string" }, "qatCreatedDate": { "type": "string", "format": "date-time" }, "qatDescription": { "type": "string" }, "qatUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qatRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPCorrectiveActionCategoryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCorrectiveActionCategoryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCorrectiveActionCodeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCorrectiveActionCodeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCorrectiveActionCodeDto": { "required": [ "qaoCorrectiveActionCodeID", "qaoDescription" ], "type": "object", "properties": { "qaoCorrectiveActionCodeID": { "type": "string" }, "qaoCorrectiveActionCategoryID": { "type": "string" }, "qaoCreatedBy": { "type": "string" }, "qaoCreatedDate": { "type": "string", "format": "date-time" }, "qaoDescription": { "type": "string" }, "qaoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qaoHoursAllowed": { "minimum": 0, "type": "number", "format": "double" }, "qaoRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPCorrectiveActionCodeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCorrectiveActionCodeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDMRClaimComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDMRClaimComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDMRClaimComponentDto": { "required": [ "dmoDescription", "dmoDmrClaimID", "dmoDmrClaimLineID", "dmoPartBinID", "dmoPartID", "dmoPartWarehouseLocationID", "dmoQuantity", "dmoDmrClaimComponentID" ], "type": "object", "properties": { "dmoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dmoCreatedBy": { "type": "string" }, "dmoCreatedDate": { "type": "string", "format": "date-time" }, "dmoDescription": { "type": "string" }, "dmoDmrClaimID": { "type": "string" }, "dmoDmrClaimLineID": { "type": "integer", "format": "int32" }, "dmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dmoInspectionComponentID": { "type": "integer", "format": "int32" }, "dmoInspectionID": { "type": "string" }, "dmoInspectionLineID": { "type": "integer", "format": "int32" }, "dmoShippedComplete": { "type": "boolean" }, "dmoJobAssemblyID": { "type": "integer", "format": "int32" }, "dmoJobID": { "type": "string" }, "dmoJobMaterialComponentID": { "type": "integer", "format": "int32" }, "dmoJobMaterialID": { "type": "integer", "format": "int32" }, "dmoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dmoPartBinID": { "type": "string" }, "dmoPartID": { "type": "string" }, "dmoPartRevisionID": { "type": "string" }, "dmoPartWarehouseLocationID": { "type": "string" }, "dmoQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dmoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "dmoQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dmoRowVersion": { "type": "integer", "format": "int64" }, "dmoDmrClaimComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "dmoUnitOfMeasure": { "type": "string" }, "dmoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPDMRClaimComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDMRClaimComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDMRClaimLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDMRClaimLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDMRClaimLineDto": { "required": [ "dmlDmrClaimID", "dmlPartBinID", "dmlPartID", "dmlPartShortDescription", "dmlPartWarehouseLocationID", "dmlQuantity", "dmlDmrClaimLineID" ], "type": "object", "properties": { "dmlConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "dmlCreatedBy": { "type": "string" }, "dmlCreatedDate": { "type": "string", "format": "date-time" }, "dmlDmrClaimID": { "type": "string" }, "dmlDmrShipmentID": { "type": "string" }, "dmlDmrShipmentLineID": { "type": "integer", "format": "int32" }, "dmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dmlExtendedCost": { "minimum": 0, "type": "number", "format": "double" }, "dmlExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "dmlInspectionID": { "type": "string" }, "dmlInspectionLineID": { "type": "integer", "format": "int32" }, "dmlInventoryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dmlInventoryQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dmlInventoryUnitOfMeasure": { "type": "string" }, "dmlInvoicedComplete": { "type": "boolean" }, "dmlKitPart": { "type": "boolean" }, "dmlScrap": { "type": "boolean" }, "dmlShippedComplete": { "type": "boolean" }, "dmlTransferredToDmrShipment": { "type": "boolean" }, "dmlTransferredToPurchaseOrder": { "type": "boolean" }, "dmlJobAssemblyID": { "type": "integer", "format": "int32" }, "dmlJobID": { "type": "string" }, "dmlJobMaterialID": { "type": "integer", "format": "int32" }, "dmlJobOperationID": { "type": "integer", "format": "int32" }, "dmlOrgPartID": { "type": "string" }, "dmlOrgPartShortDescription": { "type": "string" }, "dmlPartBinID": { "type": "string" }, "dmlPartID": { "type": "string" }, "dmlPartLongDescriptionRtf": { "type": "string" }, "dmlPartLongDescriptionText": { "type": "string" }, "dmlPartRevisionID": { "type": "string" }, "dmlPartShortDescription": { "type": "string" }, "dmlPartWarehouseLocationID": { "type": "string" }, "dmlProjectAreaID": { "type": "string" }, "dmlProjectID": { "type": "string" }, "dmlPurchaseOrderID": { "type": "string" }, "dmlPurchaseOrderLineID": { "type": "integer", "format": "int32" }, "dmlQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dmlQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dmlReceiptID": { "type": "string" }, "dmlReceiptLineID": { "type": "integer", "format": "int32" }, "dmlReceivedDate": { "type": "string", "format": "date-time" }, "dmlRequiredDate": { "type": "string", "format": "date-time" }, "dmlReturnedDate": { "type": "string", "format": "date-time" }, "dmlReturnReasonID": { "type": "string" }, "dmlRowVersion": { "type": "integer", "format": "int64" }, "dmlDmrClaimLineID": { "type": "integer", "format": "int32" }, "dmlShippedDate": { "type": "string", "format": "date-time" }, "dmlShippingMethodID": { "type": "string" }, "dmlSupplierAuthorizationNumber": { "type": "string" }, "dmlTrackingNumber": { "type": "string" }, "dmlUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "dmlUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "dmlUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPDMRClaimLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDMRClaimLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDMRClaimDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDMRClaimDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDMRClaimDto": { "required": [ "dmpClaimDate", "dmpDmrClaimID", "dmpStatus", "dmpSupplierOrganizationID" ], "type": "object", "properties": { "dmpApInvoiceContactID": { "type": "string" }, "dmpApInvoiceLocationID": { "type": "string" }, "dmpAuthorizationDate": { "type": "string", "format": "date-time" }, "dmpAuthorizationNumber": { "type": "string" }, "dmpAuthorizedByEmployeeID": { "type": "string" }, "dmpClaimDate": { "type": "string", "format": "date-time" }, "dmpClaimTotal": { "minimum": 0, "type": "number", "format": "double" }, "dmpClaimTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "dmpClosedDate": { "type": "string", "format": "date-time" }, "dmpClosedReasonID": { "type": "string" }, "dmpDmrClaimID": { "type": "string" }, "dmpCreatedBy": { "type": "string" }, "dmpCreatedDate": { "type": "string", "format": "date-time" }, "dmpCurrencyRateID": { "type": "string" }, "dmpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dmpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "dmpCustomRate": { "type": "boolean" }, "dmpPlantDepartmentID": { "type": "string" }, "dmpPlantID": { "type": "string" }, "dmpProcessedByEmployeeID": { "type": "string" }, "dmpProjectID": { "type": "string" }, "dmpPurchaseContactID": { "type": "string" }, "dmpPurchaseLocationID": { "type": "string" }, "dmpReference": { "type": "string" }, "dmpRequestedDate": { "type": "string", "format": "date-time" }, "dmpRowVersion": { "type": "integer", "format": "int64" }, "dmpStatus": { "type": "string" }, "dmpSupplierOrganizationID": { "type": "string" } } }, "ERPResponseMessageDto[ERPDMRClaimDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDMRClaimDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDMRShipmentComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDMRShipmentComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDMRShipmentComponentDto": { "required": [ "dsoDescription", "dsoDmrShipmentID", "dsoDmrShipmentLineID", "dsoPartBinID", "dsoPartID", "dsoPartWarehouseLocationID", "dsoDmrShipmentComponentID" ], "type": "object", "properties": { "dsoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dsoCreatedBy": { "type": "string" }, "dsoCreatedDate": { "type": "string", "format": "date-time" }, "dsoDescription": { "type": "string" }, "dsoDmrClaimComponentID": { "type": "integer", "format": "int32" }, "dsoDmrClaimID": { "type": "string" }, "dsoDmrClaimLineID": { "type": "integer", "format": "int32" }, "dsoDmrShipmentID": { "type": "string" }, "dsoDmrShipmentLineID": { "type": "integer", "format": "int32" }, "dsoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dsoInspectionComponentID": { "type": "integer", "format": "int32" }, "dsoInspectionID": { "type": "string" }, "dsoInspectionLineID": { "type": "integer", "format": "int32" }, "dsoInvParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dsoInvQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dsoClosed": { "type": "boolean" }, "dsoPosted": { "type": "boolean" }, "dsoReversed": { "type": "boolean" }, "dsoShippedComplete": { "type": "boolean" }, "dsoJobAssemblyID": { "type": "integer", "format": "int32" }, "dsoJobID": { "type": "string" }, "dsoJobMaterialComponentID": { "type": "integer", "format": "int32" }, "dsoJobMaterialID": { "type": "integer", "format": "int32" }, "dsoJobMatParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dsoJobMatQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dsoPartBinID": { "type": "string" }, "dsoPartID": { "type": "string" }, "dsoPartRevisionID": { "type": "string" }, "dsoPartWarehouseLocationID": { "type": "string" }, "dsoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "dsoReturnParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dsoReturnQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dsoReverseDmrShipmentCompID": { "type": "integer", "format": "int32" }, "dsoReverseDmrShipmentID": { "type": "string" }, "dsoReverseDmrShipmentLineID": { "type": "integer", "format": "int32" }, "dsoRowVersion": { "type": "integer", "format": "int64" }, "dsoDmrShipmentComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "dsoUnitOfMeasure": { "type": "string" }, "dsoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPDMRShipmentComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDMRShipmentComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDMRShipmentLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDMRShipmentLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDMRShipmentLineDto": { "required": [ "dslDmrShipmentID", "dslDmrShipmentLineID" ], "type": "object", "properties": { "dslConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "dslCreatedBy": { "type": "string" }, "dslCreatedDate": { "type": "string", "format": "date-time" }, "dslDescription": { "type": "string" }, "dslDmrClaimID": { "type": "string" }, "dslDmrClaimLineID": { "type": "integer", "format": "int32" }, "dslDmrClaimQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dslDmrOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "dslDmrShipmentID": { "type": "string" }, "dslUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dslInspectionID": { "type": "string" }, "dslInspectionLineID": { "type": "integer", "format": "int32" }, "dslInventoryQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dslInventoryUnitOfMeasure": { "type": "string" }, "dslClosed": { "type": "boolean" }, "dslInvoicedComplete": { "type": "boolean" }, "dslKitPart": { "type": "boolean" }, "dslPosted": { "type": "boolean" }, "dslReversed": { "type": "boolean" }, "dslShippedComplete": { "type": "boolean" }, "dslJobAssemblyID": { "type": "integer", "format": "int32" }, "dslJobID": { "type": "string" }, "dslJobMaterialID": { "type": "integer", "format": "int32" }, "dslJobMatQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dslJobOperationID": { "type": "integer", "format": "int32" }, "dslJobOprQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dslPartBinID": { "type": "string" }, "dslPartID": { "type": "string" }, "dslPartLongDescriptionRtf": { "type": "string" }, "dslPartLongDescriptionText": { "type": "string" }, "dslPartRevisionID": { "type": "string" }, "dslPartWarehouseLocationID": { "type": "string" }, "dslProjectAreaID": { "type": "string" }, "dslProjectID": { "type": "string" }, "dslQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dslReturnQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "dslReverseDmrShipmentID": { "type": "string" }, "dslReverseDmrShipmentLineID": { "type": "integer", "format": "int32" }, "dslRowVersion": { "type": "integer", "format": "int64" }, "dslDmrShipmentLineID": { "type": "integer", "format": "int32" }, "dslUnitOfMeasure": { "type": "string" }, "dslUnitPrice": { "minimum": 0, "type": "number", "format": "double" }, "dslUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPDMRShipmentLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDMRShipmentLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDMRShipmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDMRShipmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPDMRShipmentDto": { "required": [ "dspDmrShipmentID", "dspShipDate", "dspSupplierOrganizationID" ], "type": "object", "properties": { "dspApInvoiceLocationID": { "type": "string" }, "dspClosedDate": { "type": "string", "format": "date-time" }, "dspDmrShipmentID": { "type": "string" }, "dspCreatedBy": { "type": "string" }, "dspCreatedDate": { "type": "string", "format": "date-time" }, "dspCurrencyRateID": { "type": "string" }, "dspUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dspExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "dspFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "dspFreightChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "dspFreightSubtotal": { "minimum": 0, "type": "number", "format": "double" }, "dspFreightTotal": { "minimum": 0, "type": "number", "format": "double" }, "dspClosed": { "type": "boolean" }, "dspCustomRate": { "type": "boolean" }, "dspPosted": { "type": "boolean" }, "dspPrintDmrPackingSlip": { "type": "boolean" }, "dspPrintLabels": { "type": "boolean" }, "dspReversalEntry": { "type": "boolean" }, "dspReversed": { "type": "boolean" }, "dspNumberOfLabels": { "type": "integer", "format": "int32" }, "dspPlantDepartmentID": { "type": "string" }, "dspPlantID": { "type": "string" }, "dspPostedDate": { "type": "string", "format": "date-time" }, "dspProjectID": { "type": "string" }, "dspRowVersion": { "type": "integer", "format": "int64" }, "dspShipContactID": { "type": "string" }, "dspShipDate": { "type": "string", "format": "date-time" }, "dspShipLocationID": { "type": "string" }, "dspShippingCommentsRTF": { "type": "string" }, "dspShippingCommentsText": { "type": "string" }, "dspShippingMethodID": { "type": "string" }, "dspShippingPaymentTypeID": { "type": "string" }, "dspStandardMessageID": { "type": "string" }, "dspSupplierOrganizationID": { "type": "string" }, "dspTrackingNumber": { "type": "string" } } }, "ERPResponseMessageDto[ERPDMRShipmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDMRShipmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPInspectionComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPInspectionComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPInspectionComponentDto": { "required": [ "qamDescription", "qamInspectionID", "qamInspectionLineID", "qamPartBinID", "qamPartID", "qamPartWarehouseLocationID", "qamInspectionComponentID" ], "type": "object", "properties": { "qamAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "qamComponentQtyToInspect": { "minimum": 0, "type": "number", "format": "double" }, "qamCreatedBy": { "type": "string" }, "qamCreatedDate": { "type": "string", "format": "date-time" }, "qamDescription": { "type": "string" }, "qamUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qamInspectionID": { "type": "string" }, "qamInspectionLineID": { "type": "integer", "format": "int32" }, "qamInspectionType": { "type": "integer", "format": "int32" }, "qamInvParentQtyAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qamInvParentQtyToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qamInvParentQtyToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qamInvQuantityAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qamInvQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qamInvQuantityToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qamInspectionComplete": { "type": "boolean" }, "qamManualInspectionFinalized": { "type": "boolean" }, "qamPosted": { "type": "boolean" }, "qamJobAssemblyID": { "type": "integer", "format": "int32" }, "qamJobID": { "type": "string" }, "qamJobMaterialComponentID": { "type": "integer", "format": "int32" }, "qamJobMaterialID": { "type": "integer", "format": "int32" }, "qamJobMatParentQtyAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qamJobMatParentQtyToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qamJobMatParentQtyToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qamJobMatQuantityAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qamJobMatQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qamJobMatQuantityToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qamParentQtyToInspect": { "minimum": 0, "type": "number", "format": "double" }, "qamPartBinID": { "type": "string" }, "qamPartID": { "type": "string" }, "qamPartRevisionID": { "type": "string" }, "qamPartWarehouseLocationID": { "type": "string" }, "qamQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "qamInspectionComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "qamSourceTableName": { "type": "string" }, "qamSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qamUnitOfMeasure": { "type": "string" }, "qamWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPInspectionComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPInspectionComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPInspectionLineApprovalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPInspectionLineApprovalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPInspectionLineApprovalDto": { "required": [ "qaaInspectionID", "qaaInspectionLineID", "qaaInspectionLineApprovalID" ], "type": "object", "properties": { "qaaApprovalEmployeeID": { "type": "string" }, "qaaCreatedBy": { "type": "string" }, "qaaCreatedDate": { "type": "string", "format": "date-time" }, "qaaDescription": { "type": "string" }, "qaaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qaaInspectionID": { "type": "string" }, "qaaInspectionLineID": { "type": "integer", "format": "int32" }, "qaaInspectionLineApprovalID": { "type": "integer", "format": "int32" }, "qaaStatus": { "type": "integer", "format": "int32" }, "qaaStatusDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPInspectionLineApprovalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPInspectionLineApprovalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPInspectionLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPInspectionLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPInspectionLineDto": { "required": [ "qalApprovalStatus", "qalInspectionID", "qalInspectionType", "qalPartBinID", "qalPartID", "qalPartShortDescription", "qalPartWarehouseLocationID", "qalInspectionLineID", "qalStatus" ], "type": "object", "properties": { "qalActionType": { "type": "integer", "format": "int32" }, "qalApprovalDecisionDate": { "type": "string", "format": "date-time" }, "qalApprovalRequestDate": { "type": "string", "format": "date-time" }, "qalApprovalStatus": { "type": "integer", "format": "int32" }, "qalClosedDate": { "type": "string", "format": "date-time" }, "qalCreatedBy": { "type": "string" }, "qalCreatedDate": { "type": "string", "format": "date-time" }, "qalUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qalInspectionDate": { "type": "string", "format": "date-time" }, "qalInspectionID": { "type": "string" }, "qalInspectionNotesRTF": { "type": "string" }, "qalInspectionNotesText": { "type": "string" }, "qalInspectionType": { "type": "integer", "format": "int32" }, "qalInspectorEmployeeID": { "type": "string" }, "qalInvQuantityAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qalInvQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qalInvQuantityToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qalFirstOffInspection": { "type": "boolean" }, "qalInspectionComplete": { "type": "boolean" }, "qalKitPart": { "type": "boolean" }, "qalManualInspectionFinalized": { "type": "boolean" }, "qalPosted": { "type": "boolean" }, "qalReturnToSupplier": { "type": "boolean" }, "qalReversed": { "type": "boolean" }, "qalTransferredToDmr": { "type": "boolean" }, "qalJobAssemblyID": { "type": "integer", "format": "int32" }, "qalJobID": { "type": "string" }, "qalJobMaterialID": { "type": "integer", "format": "int32" }, "qalJobMatQuantityAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qalJobMatQuantityRejected": { "minimum": 0, "type": "number", "format": "double" }, "qalJobMatQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qalJobMatQuantityToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qalJobOperationID": { "type": "integer", "format": "int32" }, "qalJobOprQuantityAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qalJobOprQuantityRejected": { "minimum": 0, "type": "number", "format": "double" }, "qalJobOprQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qalJobOprQuantityToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qalJobType": { "type": "integer", "format": "int32" }, "qalMfgReceiptQuantityAccepted": { "minimum": 0, "type": "number", "format": "double" }, "qalMfgReceiptQuantityToReturn": { "minimum": 0, "type": "number", "format": "double" }, "qalMfgReceiptQuantityToScrap": { "minimum": 0, "type": "number", "format": "double" }, "qalNextApprovalEmployeeID": { "type": "string" }, "qalPartBinID": { "type": "string" }, "qalPartID": { "type": "string" }, "qalPartLongDescriptionRtf": { "type": "string" }, "qalPartLongDescriptionText": { "type": "string" }, "qalPartRevisionID": { "type": "string" }, "qalPartShortDescription": { "type": "string" }, "qalPartTransactionID": { "type": "integer", "format": "int32" }, "qalPartWarehouseLocationID": { "type": "string" }, "qalProjectAreaID": { "type": "string" }, "qalProjectID": { "type": "string" }, "qalPurchaseLocationID": { "type": "string" }, "qalQuantityRejected": { "minimum": 0, "type": "number", "format": "double" }, "qalQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "qalReverseInspectionID": { "type": "string" }, "qalReverseInspectionLineID": { "type": "integer", "format": "int32" }, "qalScrapReasonID": { "type": "string" }, "qalInspectionLineID": { "type": "integer", "format": "int32" }, "qalSourceTableName": { "type": "string" }, "qalSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qalStatus": { "type": "string" }, "qalSupplierOrganizationID": { "type": "string" }, "qalUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "qalUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPInspectionLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPInspectionLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPInspectionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPInspectionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPInspectionDto": { "required": [ "qapInspectionID" ], "type": "object", "properties": { "qapInspectionID": { "type": "string" }, "qapCreatedBy": { "type": "string" }, "qapCreatedDate": { "type": "string", "format": "date-time" }, "qapUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qapPosted": { "type": "boolean" }, "qapReversalEntry": { "type": "boolean" }, "qapOpenedByEmployeeID": { "type": "string" }, "qapOpenedDate": { "type": "string", "format": "date-time" }, "qapPlantDepartmentID": { "type": "string" }, "qapPlantID": { "type": "string" }, "qapPostedDate": { "type": "string", "format": "date-time" }, "qapProjectID": { "type": "string" }, "qapRowVersion": { "type": "integer", "format": "int64" }, "qapSourceTableName": { "type": "string" }, "qapSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" } } }, "ERPResponseMessageDto[ERPInspectionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPInspectionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPNonConformanceCategoryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPNonConformanceCategoryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPNonConformanceCategoryDto": { "required": [ "qagNonConformanceCategoryID", "qagDescription" ], "type": "object", "properties": { "qagNonConformanceCategoryID": { "type": "string" }, "qagCreatedBy": { "type": "string" }, "qagCreatedDate": { "type": "string", "format": "date-time" }, "qagDescription": { "type": "string" }, "qagUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qagRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPNonConformanceCategoryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPNonConformanceCategoryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPNonConformanceCauseDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPNonConformanceCauseDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPNonConformanceCauseDto": { "required": [ "qauNonConformanceCauseID", "qauDescription" ], "type": "object", "properties": { "qauNonConformanceCauseID": { "type": "string" }, "qauCreatedBy": { "type": "string" }, "qauCreatedDate": { "type": "string", "format": "date-time" }, "qauDescription": { "type": "string" }, "qauUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qauRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPNonConformanceCauseDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPNonConformanceCauseDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPNonConformanceCodeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPNonConformanceCodeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPNonConformanceCodeDto": { "required": [ "qacNonConformanceCodeID", "qacDescription" ], "type": "object", "properties": { "qacNonConformanceCodeID": { "type": "string" }, "qacCreatedBy": { "type": "string" }, "qacCreatedDate": { "type": "string", "format": "date-time" }, "qacDescription": { "type": "string" }, "qacUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qacNonConformanceCategoryID": { "type": "string" }, "qacRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPNonConformanceCodeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPNonConformanceCodeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPNonConformanceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPNonConformanceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPNonConformanceDto": { "required": [ "qarNonConformanceID" ], "type": "object", "properties": { "qarActualHours": { "minimum": 0, "type": "number", "format": "double" }, "qarNonConformanceID": { "type": "string" }, "qarCorrectiveActionCategoryID": { "type": "string" }, "qarCorrectiveActionCodeID": { "type": "string" }, "qarCorrectiveActionDate": { "type": "string", "format": "date-time" }, "qarCorrectiveActionRTF": { "type": "string" }, "qarCorrectiveActionText": { "type": "string" }, "qarCorrectiveActionType": { "type": "integer", "format": "int32" }, "qarCreatedBy": { "type": "string" }, "qarCreatedDate": { "type": "string", "format": "date-time" }, "qarUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qarHoursAllowed": { "minimum": 0, "type": "number", "format": "double" }, "qarHoursRequested": { "minimum": 0, "type": "number", "format": "double" }, "qarInspectionID": { "type": "string" }, "qarInspectionLineID": { "type": "integer", "format": "int32" }, "qarCorrectiveActionComplete": { "type": "boolean" }, "qarJobAssemblyID": { "type": "integer", "format": "int32" }, "qarJobID": { "type": "string" }, "qarJobMaterialID": { "type": "integer", "format": "int32" }, "qarJobOperationID": { "type": "integer", "format": "int32" }, "qarNonConformanceCategoryID": { "type": "string" }, "qarNonConformanceCauseID": { "type": "string" }, "qarNonConformanceCodeID": { "type": "string" }, "qarNonConformanceRTF": { "type": "string" }, "qarNonConformanceText": { "type": "string" }, "qarPartBinID": { "type": "string" }, "qarPartID": { "type": "string" }, "qarPartRevisionID": { "type": "string" }, "qarPartShortDescription": { "type": "string" }, "qarPartWareHouseLocationID": { "type": "string" }, "qarQuantity": { "minimum": 0, "type": "number", "format": "double" }, "qarRepairedByOrganizationID": { "type": "string" }, "qarReportedByEmployeeID": { "type": "string" }, "qarRmaClaimID": { "type": "string" }, "qarRmaClaimLineID": { "type": "integer", "format": "int32" }, "qarRowVersion": { "type": "integer", "format": "int64" }, "qarSubcontractAmount": { "minimum": 0, "type": "number", "format": "double" }, "qarSubcontractAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "qarUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPNonConformanceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPNonConformanceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAActionTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAActionTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPRMAActionTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAActionTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAClaimComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAClaimComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRMAClaimComponentDto": { "required": [ "raoDescription", "raoPartBinID", "raoPartID", "raoPartWarehouseLocationID", "raoQuantity", "raoRmaClaimID", "raoRmaClaimLineID", "raoRmaClaimComponentID" ], "type": "object", "properties": { "raoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "raoCreatedBy": { "type": "string" }, "raoCreatedDate": { "type": "string", "format": "date-time" }, "raoDescription": { "type": "string" }, "raoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "raoReceivedComplete": { "type": "boolean" }, "raoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "raoPartBinID": { "type": "string" }, "raoPartID": { "type": "string" }, "raoPartRevisionID": { "type": "string" }, "raoPartWarehouseLocationID": { "type": "string" }, "raoQuantity": { "minimum": 0, "type": "number", "format": "double" }, "raoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "raoQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "raoRmaClaimID": { "type": "string" }, "raoRmaClaimLineID": { "type": "integer", "format": "int32" }, "raoRowVersion": { "type": "integer", "format": "int64" }, "raoRmaClaimComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "raoShipmentComponentID": { "type": "integer", "format": "int32" }, "raoShipmentID": { "type": "string" }, "raoShipmentLineID": { "type": "integer", "format": "int32" }, "raoUnitOfMeasure": { "type": "string" }, "raoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPRMAClaimComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAClaimComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAClaimLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAClaimLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRMAClaimLineDto": { "required": [ "ralPartBinID", "ralPartID", "ralPartShortDescription", "ralPartWarehouseLocationID", "ralQuantity", "ralRmaClaimID", "ralSalesQuantity", "ralRmaClaimLineID" ], "type": "object", "properties": { "ralActionType": { "type": "string" }, "ralConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "ralCreatedBy": { "type": "string" }, "ralCreatedDate": { "type": "string", "format": "date-time" }, "ralCustomerPo": { "type": "string" }, "ralDiscountPercent": { "minimum": 0, "type": "number", "format": "double" }, "ralUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ralExtendedCost": { "minimum": 0, "type": "number", "format": "double" }, "ralExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralExtendedDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "ralExtendedDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralExtendedPrice": { "minimum": 0, "type": "number", "format": "double" }, "ralExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralFullExtendedPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "ralFullExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralFullUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "ralFullUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralCustomerToPayForShipping": { "type": "boolean" }, "ralInvoicedComplete": { "type": "boolean" }, "ralKitPart": { "type": "boolean" }, "ralReceivedComplete": { "type": "boolean" }, "ralRequiresInspection": { "type": "boolean" }, "ralReturnToSupplier": { "type": "boolean" }, "ralTransferredToSalesOrder": { "type": "boolean" }, "ralOrgPartID": { "type": "string" }, "ralOrgPartShortDescription": { "type": "string" }, "ralPartBinID": { "type": "string" }, "ralPartGroupID": { "type": "string" }, "ralPartID": { "type": "string" }, "ralPartLongDescriptionRtf": { "type": "string" }, "ralPartLongDescriptionText": { "type": "string" }, "ralPartRevisionID": { "type": "string" }, "ralPartShortDescription": { "type": "string" }, "ralPartWarehouseLocationID": { "type": "string" }, "ralProjectAreaID": { "type": "string" }, "ralProjectID": { "type": "string" }, "ralPurchaseLocationID": { "type": "string" }, "ralQuantity": { "minimum": 0, "type": "number", "format": "double" }, "ralQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "ralReceivedDate": { "type": "string", "format": "date-time" }, "ralRequiredDate": { "type": "string", "format": "date-time" }, "ralReturnedDate": { "type": "string", "format": "date-time" }, "ralReturnReasonID": { "type": "string" }, "ralRmaClaimID": { "type": "string" }, "ralRowVersion": { "type": "integer", "format": "int64" }, "ralSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "ralSalesOrderID": { "type": "string" }, "ralSalesOrderLineID": { "type": "integer", "format": "int32" }, "ralSalesQuantity": { "minimum": 0, "type": "number", "format": "double" }, "ralSalesUnitOfMeasure": { "type": "string" }, "ralRmaClaimLineID": { "type": "integer", "format": "int32" }, "ralShipmentID": { "type": "string" }, "ralShipmentLineID": { "type": "integer", "format": "int32" }, "ralShippedDate": { "type": "string", "format": "date-time" }, "ralShippingMethodID": { "type": "string" }, "ralShippingPaymentTypeID": { "type": "string" }, "ralSupplierAuthorizationNumber": { "type": "string" }, "ralSupplierOrganizationID": { "type": "string" }, "ralSupplierShippingMethodID": { "type": "string" }, "ralSupplierTrackingNumber": { "type": "string" }, "ralTrackingNumber": { "type": "string" }, "ralUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "ralUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralUnitDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "ralUnitDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "ralUnitOfMeasure": { "type": "string" }, "ralUnitPrice": { "minimum": 0, "type": "number", "format": "double" }, "ralUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPRMAClaimLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAClaimLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAClaimDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAClaimDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRMAClaimDto": { "required": [ "rapClaimDate", "rapRmaClaimID", "rapCustomerOrganizationID", "rapPayTo", "rapProcessedByEmployeeID", "rapShipOrganizationID", "rapStatus" ], "type": "object", "properties": { "rapActualHoursTotal": { "minimum": 0, "type": "number", "format": "double" }, "rapArInvoiceContactID": { "type": "string" }, "rapArInvoiceLocationID": { "type": "string" }, "rapAuthorizationDate": { "type": "string", "format": "date-time" }, "rapAuthorizationNumber": { "type": "string" }, "rapAuthorizedByEmployeeID": { "type": "string" }, "rapClaimDate": { "type": "string", "format": "date-time" }, "rapClaimTotal": { "minimum": 0, "type": "number", "format": "double" }, "rapClaimTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "rapClosedDate": { "type": "string", "format": "date-time" }, "rapClosedReasonID": { "type": "string" }, "rapRmaClaimID": { "type": "string" }, "rapCreatedBy": { "type": "string" }, "rapCreatedDate": { "type": "string", "format": "date-time" }, "rapCurrencyRateID": { "type": "string" }, "rapCustomerOrganizationID": { "type": "string" }, "rapDiscountAmount": { "minimum": 0, "type": "number", "format": "double" }, "rapDiscountAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "rapUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rapExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "rapFreightAmount": { "minimum": 0, "type": "number", "format": "double" }, "rapFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "rapCustomRate": { "type": "boolean" }, "rapLaborRate": { "minimum": 0, "type": "number", "format": "double" }, "rapLaborRateForeign": { "minimum": 0, "type": "number", "format": "double" }, "rapLaborTotal": { "minimum": 0, "type": "number", "format": "double" }, "rapLaborTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "rapLongDescriptionRtf": { "type": "string" }, "rapLongDescriptionText": { "type": "string" }, "rapPartID": { "type": "string" }, "rapPartRevisionID": { "type": "string" }, "rapPartShortDescription": { "type": "string" }, "rapPartsTotal": { "minimum": 0, "type": "number", "format": "double" }, "rapPartsTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "rapPayTo": { "type": "integer", "format": "int32" }, "rapPlantDepartmentID": { "type": "string" }, "rapPlantID": { "type": "string" }, "rapProcessedByEmployeeID": { "type": "string" }, "rapProjectID": { "type": "string" }, "rapReference": { "type": "string" }, "rapRequestedDate": { "type": "string", "format": "date-time" }, "rapResellerContactID": { "type": "string" }, "rapResellerLocationID": { "type": "string" }, "rapResellerOrganizationID": { "type": "string" }, "rapRowVersion": { "type": "integer", "format": "int64" }, "rapSerialNumberID": { "type": "string" }, "rapShipContactID": { "type": "string" }, "rapShipLocationID": { "type": "string" }, "rapShipOrganizationID": { "type": "string" }, "rapStatus": { "type": "string" }, "rapSubcontractTotal": { "minimum": 0, "type": "number", "format": "double" }, "rapSubcontractTotalForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPRMAClaimDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAClaimDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAReceiptComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAReceiptComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRMAReceiptComponentDto": { "required": [ "rroDescription", "rroPartBinID", "rroPartID", "rroPartWarehouseLocationID", "rroRmaReceiptID", "rroRmaReceiptLineID", "rroRmaReceiptComponentID" ], "type": "object", "properties": { "rroAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rroCreatedBy": { "type": "string" }, "rroCreatedDate": { "type": "string", "format": "date-time" }, "rroDescription": { "type": "string" }, "rroUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rroExtendedCost": { "minimum": 0, "type": "number", "format": "double" }, "rroExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rroInspParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rroClosed": { "type": "boolean" }, "rroInspectionComplete": { "type": "boolean" }, "rroPosted": { "type": "boolean" }, "rroReceivedComplete": { "type": "boolean" }, "rroReversed": { "type": "boolean" }, "rroParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rroPartBinID": { "type": "string" }, "rroPartID": { "type": "string" }, "rroPartRevisionID": { "type": "string" }, "rroPartWarehouseLocationID": { "type": "string" }, "rroQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "rroQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rroQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "rroReverseRmaReceiptCompID": { "type": "integer", "format": "int32" }, "rroReverseRmaReceiptID": { "type": "string" }, "rroReverseRmaReceiptLineID": { "type": "integer", "format": "int32" }, "rroRmaClaimComponentID": { "type": "integer", "format": "int32" }, "rroRmaClaimID": { "type": "string" }, "rroRmaClaimLineID": { "type": "integer", "format": "int32" }, "rroRmaReceiptID": { "type": "string" }, "rroRmaReceiptLineID": { "type": "integer", "format": "int32" }, "rroRowVersion": { "type": "integer", "format": "int64" }, "rroRmaReceiptComponentID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "rroUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rroUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rroUnitOfMeasure": { "type": "string" }, "rroWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPRMAReceiptComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAReceiptComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAReceiptLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAReceiptLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRMAReceiptLineDto": { "required": [ "rrlPartBinID", "rrlPartID", "rrlPartWarehouseLocationID", "rrlRmaReceiptID", "rrlRmaReceiptLineID" ], "type": "object", "properties": { "rrlConversionFactor": { "minimum": 0, "type": "number", "format": "double" }, "rrlCreatedBy": { "type": "string" }, "rrlCreatedDate": { "type": "string", "format": "date-time" }, "rrlDescription": { "type": "string" }, "rrlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rrlExtendedCost": { "minimum": 0, "type": "number", "format": "double" }, "rrlExtendedCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "rrlHeatLot": { "type": "string" }, "rrlInventoryQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rrlInventoryUnitOfMeasure": { "type": "string" }, "rrlClosed": { "type": "boolean" }, "rrlInInspection": { "type": "boolean" }, "rrlInspectionComplete": { "type": "boolean" }, "rrlInvoicedComplete": { "type": "boolean" }, "rrlKitPart": { "type": "boolean" }, "rrlPosted": { "type": "boolean" }, "rrlReceivedComplete": { "type": "boolean" }, "rrlRequiresInspection": { "type": "boolean" }, "rrlReversed": { "type": "boolean" }, "rrlOrgPartID": { "type": "string" }, "rrlOrgPartShortDescription": { "type": "string" }, "rrlPartBinID": { "type": "string" }, "rrlPartID": { "type": "string" }, "rrlPartLongDescriptionRtf": { "type": "string" }, "rrlPartLongDescriptionText": { "type": "string" }, "rrlPartRevisionID": { "type": "string" }, "rrlPartWarehouseLocationID": { "type": "string" }, "rrlProjectAreaID": { "type": "string" }, "rrlProjectID": { "type": "string" }, "rrlQuantityToInspect": { "minimum": 0, "type": "number", "format": "double" }, "rrlReference": { "type": "string" }, "rrlReverseRmaReceiptID": { "type": "string" }, "rrlReverseRmaReceiptLineID": { "type": "integer", "format": "int32" }, "rrlRmaClaimID": { "type": "string" }, "rrlRmaClaimLineID": { "type": "integer", "format": "int32" }, "rrlRmaClaimQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rrlRmaOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "rrlRmaReceiptID": { "type": "string" }, "rrlRowVersion": { "type": "integer", "format": "int64" }, "rrlSalesQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "rrlSalesUnitOfMeasure": { "type": "string" }, "rrlRmaReceiptLineID": { "type": "integer", "format": "int32" }, "rrlTotalComponentCosts": { "minimum": 0, "type": "number", "format": "double" }, "rrlUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "rrlUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPRMAReceiptLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAReceiptLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPRMAReceiptDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPRMAReceiptDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPRMAReceiptDto": { "required": [ "rrpRmaReceiptID", "rrpCustomerOrganizationID", "rrpReceiptDate", "rrpShipOrganizationID" ], "type": "object", "properties": { "rrpArInvoiceContactID": { "type": "string" }, "rrpArInvoiceLocationID": { "type": "string" }, "rrpClosedDate": { "type": "string", "format": "date-time" }, "rrpRmaReceiptID": { "type": "string" }, "rrpCreatedBy": { "type": "string" }, "rrpCreatedDate": { "type": "string", "format": "date-time" }, "rrpCurrencyRateID": { "type": "string" }, "rrpCustomerOrganizationID": { "type": "string" }, "rrpDeliveryDocket": { "type": "string" }, "rrpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rrpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "rrpFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "rrpFreightChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "rrpClosed": { "type": "boolean" }, "rrpCustomRate": { "type": "boolean" }, "rrpPosted": { "type": "boolean" }, "rrpReversalEntry": { "type": "boolean" }, "rrpReversed": { "type": "boolean" }, "rrpPlantDepartmentID": { "type": "string" }, "rrpPlantID": { "type": "string" }, "rrpPostedDate": { "type": "string", "format": "date-time" }, "rrpProjectID": { "type": "string" }, "rrpReceiptDate": { "type": "string", "format": "date-time" }, "rrpRowVersion": { "type": "integer", "format": "int64" }, "rrpShipContactID": { "type": "string" }, "rrpShipLocationID": { "type": "string" }, "rrpShipOrganizationID": { "type": "string" }, "rrpShippingMethodID": { "type": "string" } } }, "ERPResponseMessageDto[ERPRMAReceiptDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPRMAReceiptDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteAssemblyDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteAssemblyDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteAssemblyDto": { "required": [ "qmaLevel", "qmaPartID", "qmaPartShortDescription", "qmaQuantityPerParent", "qmaQuoteID", "qmaQuoteLineID", "qmaQuoteAssemblyID" ], "type": "object", "properties": { "qmaAssemblyOverlap": { "type": "integer", "format": "int32" }, "qmaCreatedBy": { "type": "string" }, "qmaCreatedDate": { "type": "string", "format": "date-time" }, "qmaDocuments": { "type": "string" }, "qmaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmaClosed": { "type": "boolean" }, "qmaPullAllFromStock": { "type": "boolean" }, "qmaLevel": { "type": "integer", "format": "int32" }, "qmaOverlapDestinationLink": { "type": "integer", "format": "int32" }, "qmaOverlapOffsetTime": { "minimum": 0, "type": "number", "format": "double" }, "qmaOverlapOperationID": { "type": "integer", "format": "int32" }, "qmaOverlapSourceLink": { "type": "integer", "format": "int32" }, "qmaOverlapSourceOperationID": { "type": "integer", "format": "int32" }, "qmaOverlapType": { "type": "integer", "format": "int32" }, "qmaParentAssemblyID": { "type": "integer", "format": "int32" }, "qmaPartID": { "type": "string" }, "qmaPartLongDescriptionRtf": { "type": "string" }, "qmaPartLongDescriptionText": { "type": "string" }, "qmaPartRevisionID": { "type": "string" }, "qmaPartShortDescription": { "type": "string" }, "qmaProductionNotesRTF": { "type": "string" }, "qmaProductionNotesText": { "type": "string" }, "qmaQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "qmaQuoteID": { "type": "string" }, "qmaQuoteLineID": { "type": "integer", "format": "int32" }, "qmaRowVersion": { "type": "integer", "format": "int64" }, "qmaQuoteAssemblyID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "qmaSourceMethodID": { "type": "string" }, "qmaSourceRevisionID": { "type": "string" }, "qmaUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPQuoteAssemblyDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteAssemblyDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteLineDto": { "required": [ "qmlPartID", "qmlPartShortDescription", "qmlQuoteID", "qmlQuoteMarkupType", "qmlQuoteLineID" ], "type": "object", "properties": { "qmlCreatedBy": { "type": "string" }, "qmlCreatedDate": { "type": "string", "format": "date-time" }, "qmlDocuments": { "type": "string" }, "qmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmlClosed": { "type": "boolean" }, "qmlCreatedFromMobile": { "type": "boolean" }, "qmlFirm": { "type": "boolean" }, "qmlMatrixCalculated": { "type": "boolean" }, "qmlPurchaseToOrder": { "type": "boolean" }, "qmlTransferredToOrder": { "type": "boolean" }, "qmlLeadID": { "type": "string" }, "qmlLeadLineID": { "type": "integer", "format": "int32" }, "qmlNonTaxReasonID": { "type": "string" }, "qmlOrgPartID": { "type": "string" }, "qmlOrgPartShortDescription": { "type": "string" }, "qmlPartGroupID": { "type": "string" }, "qmlPartID": { "type": "string" }, "qmlPartLongDescriptionRtf": { "type": "string" }, "qmlPartLongDescriptionText": { "type": "string" }, "qmlPartRevisionID": { "type": "string" }, "qmlPartShortDescription": { "type": "string" }, "qmlProductionNotesRTF": { "type": "string" }, "qmlProductionNotesText": { "type": "string" }, "qmlProjectAreaID": { "type": "string" }, "qmlProjectID": { "type": "string" }, "qmlPurchaseLocationID": { "type": "string" }, "qmlPurchaseUnitCostBase": { "minimum": 0, "type": "number", "format": "double" }, "qmlPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmlQuantityToTotal": { "type": "integer", "format": "int32" }, "qmlQuoteID": { "type": "string" }, "qmlQuoteMarkupType": { "type": "integer", "format": "int32" }, "qmlResolutionReasonID": { "type": "string" }, "qmlRowVersion": { "type": "integer", "format": "int64" }, "qmlSecondTaxCodeID": { "type": "string" }, "qmlQuoteLineID": { "type": "integer", "format": "int32" }, "qmlSourceMethodID": { "type": "string" }, "qmlSourceRevisionID": { "type": "string" }, "qmlSupplierOrganizationID": { "type": "string" }, "qmlTaxCodeID": { "type": "string" }, "qmlTaxDate": { "type": "string", "format": "date-time" }, "qmlUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPQuoteLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteMaterialDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteMaterialDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteMaterialDto": { "required": [ "qmmPartBinID", "qmmPartID", "qmmPartShortDescription", "qmmPartWarehouseLocationID", "qmmQuoteID", "qmmQuoteLineID", "qmmQuoteMaterialID" ], "type": "object", "properties": { "qmmCreatedBy": { "type": "string" }, "qmmCreatedDate": { "type": "string", "format": "date-time" }, "qmmDocuments": { "type": "string" }, "qmmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmmEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "qmmBackflush": { "type": "boolean" }, "qmmClosed": { "type": "boolean" }, "qmmCostOverride": { "type": "boolean" }, "qmmLeadTime": { "type": "integer", "format": "int32" }, "qmmLeadTime1": { "type": "integer", "format": "int32" }, "qmmLeadTime2": { "type": "integer", "format": "int32" }, "qmmLeadTime3": { "type": "integer", "format": "int32" }, "qmmLeadTime4": { "type": "integer", "format": "int32" }, "qmmLeadTime5": { "type": "integer", "format": "int32" }, "qmmLeadTime6": { "type": "integer", "format": "int32" }, "qmmLeadTime7": { "type": "integer", "format": "int32" }, "qmmLeadTime8": { "type": "integer", "format": "int32" }, "qmmLeadTime9": { "type": "integer", "format": "int32" }, "qmmMinimumCharge": { "minimum": 0, "type": "number", "format": "double" }, "qmmPartBinID": { "type": "string" }, "qmmPartID": { "type": "string" }, "qmmPartLongDescriptionRtf": { "type": "string" }, "qmmPartLongDescriptionText": { "type": "string" }, "qmmPartRevisionID": { "type": "string" }, "qmmPartShortDescription": { "type": "string" }, "qmmPartWarehouseLocationID": { "type": "string" }, "qmmPurchaseLocationID": { "type": "string" }, "qmmQuantityBreak1": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak2": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak3": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak4": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak5": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak6": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak7": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak8": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityBreak9": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuantityPerAssembly": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuoteAssemblyID": { "type": "integer", "format": "int32" }, "qmmQuoteID": { "type": "string" }, "qmmQuoteLineID": { "type": "integer", "format": "int32" }, "qmmRelatedQuoteOperationID": { "type": "integer", "format": "int32" }, "qmmRowVersion": { "type": "integer", "format": "int64" }, "qmmScrapPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmmScrapQuantity": { "minimum": 0, "type": "number", "format": "double" }, "qmmQuoteMaterialID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "qmmSourcePriceID": { "type": "integer", "format": "int32" }, "qmmSourceRfqID": { "type": "string" }, "qmmSupplierOrganizationID": { "type": "string" }, "qmmUnitCost1": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost2": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost3": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost4": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost5": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost6": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost7": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost8": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitCost9": { "minimum": 0, "type": "number", "format": "double" }, "qmmUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPQuoteMaterialDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteMaterialDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteMemoDto": { "required": [ "qmkMemoDate", "qmkQuoteID", "qmkQuoteMemoID", "qmkShortDescription" ], "type": "object", "properties": { "qmkCreatedBy": { "type": "string" }, "qmkCreatedDate": { "type": "string", "format": "date-time" }, "qmkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmkClosed": { "type": "boolean" }, "qmkLongDescriptionRtf": { "type": "string" }, "qmkLongDescriptionText": { "type": "string" }, "qmkMemoDate": { "type": "string", "format": "date-time" }, "qmkQuoteID": { "type": "string" }, "qmkRowVersion": { "type": "integer", "format": "int64" }, "qmkQuoteMemoID": { "type": "integer", "format": "int32" }, "qmkShortDescription": { "type": "string" }, "qmkShowInQuotes": { "type": "boolean" }, "qmkShowInSalesOrders": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPQuoteMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteOperationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteOperationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteOperationDto": { "required": [ "qmoMachineType", "qmoOperationType", "qmoProcessID", "qmoProcessShortDescription", "qmoQuantityPerAssembly", "qmoQuoteID", "qmoQuoteLineID", "qmoQuoteOperationID", "qmoStandardFactor", "qmoWorkCenterID" ], "type": "object", "properties": { "qmoAdditionalSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "qmoAdditionalSetupQuantity": { "minimum": 0, "type": "number", "format": "double" }, "qmoCreatedBy": { "type": "string" }, "qmoCreatedDate": { "type": "string", "format": "date-time" }, "qmoDocuments": { "type": "string" }, "qmoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmoEstimatedUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "qmoInspectionType": { "type": "integer", "format": "int32" }, "qmoClosed": { "type": "boolean" }, "qmoMachinesToSchedule": { "type": "integer", "format": "int32" }, "qmoMachineType": { "type": "integer", "format": "int32" }, "qmoMinimumCharge": { "minimum": 0, "type": "number", "format": "double" }, "qmoMoveTime": { "minimum": 0, "type": "number", "format": "double" }, "qmoOperationType": { "type": "integer", "format": "int32" }, "qmoOverheadRate": { "minimum": 0, "type": "number", "format": "double" }, "qmoOverlap": { "type": "integer", "format": "int32" }, "qmoOverlapDestinationLink": { "type": "integer", "format": "int32" }, "qmoOverlapOffsetTime": { "minimum": 0, "type": "number", "format": "double" }, "qmoOverlapOperationID": { "type": "integer", "format": "int32" }, "qmoOverlapSourceLink": { "type": "integer", "format": "int32" }, "qmoPartID": { "type": "string" }, "qmoPartRevisionID": { "type": "string" }, "qmoPlantDepartmentID": { "type": "string" }, "qmoPlantID": { "type": "string" }, "qmoProcessID": { "type": "string" }, "qmoProcessLongDescriptionRtf": { "type": "string" }, "qmoProcessLongDescriptionText": { "type": "string" }, "qmoProcessShortDescription": { "type": "string" }, "qmoProductionRate": { "minimum": 0, "type": "number", "format": "double" }, "qmoProductionStandard": { "minimum": 0, "type": "number", "format": "double" }, "qmoPurchaseLocationID": { "type": "string" }, "qmoQuantityBreak1": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak2": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak3": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak4": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak5": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak6": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak7": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak8": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityBreak9": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuantityPerAssembly": { "minimum": 0, "type": "number", "format": "double" }, "qmoQueueTime": { "minimum": 0, "type": "number", "format": "double" }, "qmoQuoteAssemblyID": { "type": "integer", "format": "int32" }, "qmoQuoteID": { "type": "string" }, "qmoQuoteLineID": { "type": "integer", "format": "int32" }, "qmoQuotingRate": { "minimum": 0, "type": "number", "format": "double" }, "qmoRowVersion": { "type": "integer", "format": "int64" }, "qmoQuoteOperationID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "qmoSetupCharge": { "minimum": 0, "type": "number", "format": "double" }, "qmoSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "qmoSetupRate": { "minimum": 0, "type": "number", "format": "double" }, "qmoSfeMessageRTF": { "type": "string" }, "qmoSfeMessageText": { "type": "string" }, "qmoStandardFactor": { "type": "string" }, "qmoSupplierOrganizationID": { "type": "string" }, "qmoUnitCost1": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost2": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost3": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost4": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost5": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost6": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost7": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost8": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitCost9": { "minimum": 0, "type": "number", "format": "double" }, "qmoUnitOfMeasure": { "type": "string" }, "qmoWorkCenterID": { "type": "string" }, "qmoWorkCenterMachineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPQuoteOperationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteOperationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteQuantityDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteQuantityDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteQuantityDto": { "required": [ "qmqQuoteID", "qmqQuoteLineID", "qmqQuoteMarkupType", "qmqQuoteQuantity", "qmqQuoteQuantityID" ], "type": "object", "properties": { "qmqAdditionalChargeBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqAdditionalChargeDescription": { "type": "string" }, "qmqAdditionalChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqAdditionalCostAmount": { "minimum": 0, "type": "number", "format": "double" }, "qmqAdditionalCostDescription": { "type": "string" }, "qmqAdditionalCostPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqAdditionalMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqAddSecondTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqAddSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqAddTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqAddTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqCalculatedUnitPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqCommissionPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqCreatedBy": { "type": "string" }, "qmqCreatedDate": { "type": "string", "format": "date-time" }, "qmqDiscountPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqDueDate": { "type": "string", "format": "date-time" }, "qmqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmqFullRevisedUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqFullRevisedUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqClosed": { "type": "boolean" }, "qmqCreatedFromMobile": { "type": "boolean" }, "qmqPurchaseToOrder": { "type": "boolean" }, "qmqLaborCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqLaborMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqLaborPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqLeadTime": { "type": "string" }, "qmqMaterialCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqMaterialMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqMaterialPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqOverheadCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqOverheadMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqOverheadPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqProductionHours": { "minimum": 0, "type": "number", "format": "double" }, "qmqPurchaseToOrderCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqPurchaseToOrderPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqPurchaseUnitCostBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqPurToOrderMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqQuoteID": { "type": "string" }, "qmqQuoteLineID": { "type": "integer", "format": "int32" }, "qmqQuoteMarkupType": { "type": "integer", "format": "int32" }, "qmqQuoteQuantity": { "minimum": 0, "type": "number", "format": "double" }, "qmqQuotingCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqQuotingMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqQuotingPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqRevisedUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqRevisedUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqRowVersion": { "type": "integer", "format": "int64" }, "qmqScrapPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqSecondTaxCodeID": { "type": "string" }, "qmqQuoteQuantityID": { "type": "integer", "format": "int32" }, "qmqSetupHours": { "minimum": 0, "type": "number", "format": "double" }, "qmqStartDate": { "type": "string", "format": "date-time" }, "qmqSubcontractCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqSubcontractMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqSubcontractPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqTaxCodeID": { "type": "string" }, "qmqTaxDate": { "type": "string", "format": "date-time" }, "qmqTotalCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqTotalMarkupPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmqTotalPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqTotalRunQuantity": { "minimum": 0, "type": "number", "format": "double" }, "qmqTotalUnitCost": { "minimum": 0, "type": "number", "format": "double" }, "qmqTotalUnitPrice": { "minimum": 0, "type": "number", "format": "double" }, "qmqUnitDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqUnitDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqUnitSecondTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqUnitSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "qmqUnitTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "qmqUnitTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPQuoteQuantityDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteQuantityDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteDto": { "required": [ "qmpQuoteID", "qmpCustomerOrganizationID", "qmpDueDate", "qmpQuoterEmployeeID", "qmpShipOrganizationID" ], "type": "object", "properties": { "qmpArInvoiceContactID": { "type": "string" }, "qmpArInvoiceLocationID": { "type": "string" }, "qmpClosedDate": { "type": "string", "format": "date-time" }, "qmpQuoteID": { "type": "string" }, "qmpCreatedBy": { "type": "string" }, "qmpCreatedDate": { "type": "string", "format": "date-time" }, "qmpCurrencyRateID": { "type": "string" }, "qmpCustomerOrganizationID": { "type": "string" }, "qmpDueDate": { "type": "string", "format": "date-time" }, "qmpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "qmpExpirationDate": { "type": "string", "format": "date-time" }, "qmpFreeOnBoardDescription": { "type": "string" }, "qmpAvalaraTaxCalculated": { "type": "boolean" }, "qmpClosed": { "type": "boolean" }, "qmpCreatedFromMobile": { "type": "boolean" }, "qmpCustomRate": { "type": "boolean" }, "qmpPaymentTermID": { "type": "string" }, "qmpPlantDepartmentID": { "type": "string" }, "qmpPlantID": { "type": "string" }, "qmpProjectID": { "type": "string" }, "qmpQuoteContactID": { "type": "string" }, "qmpQuoteDate": { "type": "string", "format": "date-time" }, "qmpQuoteFooterMessageRTF": { "type": "string" }, "qmpQuoteFooterMessageText": { "type": "string" }, "qmpQuoteHeaderMessageRTF": { "type": "string" }, "qmpQuoteHeaderMessageText": { "type": "string" }, "qmpQuoteLocationID": { "type": "string" }, "qmpQuoterEmployeeID": { "type": "string" }, "qmpRowVersion": { "type": "integer", "format": "int64" }, "qmpShipContactID": { "type": "string" }, "qmpShipLocationID": { "type": "string" }, "qmpShipOrganizationID": { "type": "string" }, "qmpShippingMethodID": { "type": "string" }, "qmpShippingPaymentTypeID": { "type": "string" }, "qmpSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "qmpStandardMessageID": { "type": "string" }, "qmpTaxDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPQuoteDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPQuoteSalesPersonDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPQuoteSalesPersonDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPQuoteSalesPersonDto": { "required": [ "qmjQuoteID", "qmjSalesEmployeeID", "qmjSequenceID" ], "type": "object", "properties": { "qmjCreatedBy": { "type": "string" }, "qmjCreatedDate": { "type": "string", "format": "date-time" }, "qmjUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "qmjClosed": { "type": "boolean" }, "qmjCreatedFromMobile": { "type": "boolean" }, "qmjPercent": { "minimum": 0, "type": "number", "format": "double" }, "qmjQuoteID": { "type": "string" }, "qmjRowVersion": { "type": "integer", "format": "int64" }, "qmjSalesEmployeeID": { "type": "string" }, "qmjSequenceID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPQuoteSalesPersonDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPQuoteSalesPersonDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderApprovalDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderApprovalDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderApprovalDto": { "required": [ "omaSalesOrderID", "omaSalesOrderApprovalID" ], "type": "object", "properties": { "omaApprovalEmployeeID": { "type": "string" }, "omaCreatedBy": { "type": "string" }, "omaCreatedDate": { "type": "string", "format": "date-time" }, "omaDescription": { "type": "string" }, "omaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omaRowVersion": { "type": "integer", "format": "int64" }, "omaSalesOrderID": { "type": "string" }, "omaSalesOrderApprovalID": { "type": "integer", "format": "int32" }, "omaStatus": { "type": "integer", "format": "int32" }, "omaStatusDate": { "type": "string", "format": "date-time" } } }, "ERPResponseMessageDto[ERPSalesOrderApprovalDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderApprovalDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderComponentDto": { "required": [ "omoDeliveryQuantity", "omoDescription", "omoPartBinID", "omoPartID", "omoPartWarehouseLocationID", "omoSalesOrderDeliveryID", "omoSalesOrderID", "omoSalesOrderLineID", "omoSalesOrderComponentID" ], "type": "object", "properties": { "omoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omoCreatedBy": { "type": "string" }, "omoCreatedDate": { "type": "string", "format": "date-time" }, "omoDeliveryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omoDescription": { "type": "string" }, "omoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omoClosed": { "type": "boolean" }, "omoShippedComplete": { "type": "boolean" }, "omoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omoPartBinID": { "type": "string" }, "omoPartID": { "type": "string" }, "omoPartRevisionID": { "type": "string" }, "omoPartWarehouseLocationID": { "type": "string" }, "omoQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "omoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "omoQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "omoRowVersion": { "type": "integer", "format": "int64" }, "omoSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "omoSalesOrderID": { "type": "string" }, "omoSalesOrderLineID": { "type": "integer", "format": "int32" }, "omoSalesOrderComponentID": { "type": "integer", "format": "int32" }, "omoUnitOfMeasure": { "type": "string" }, "omoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPSalesOrderComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderDeliveryDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderDeliveryDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderDeliveryDto": { "required": [ "omdDeliveryDate", "omdDeliveryQuantity", "omdDeliveryType", "omdPartBinID", "omdPartID", "omdPartWarehouseLocationID", "omdSalesOrderID", "omdSalesOrderLineID", "omdSalesOrderDeliveryID" ], "type": "object", "properties": { "omdAmountToInvoice": { "minimum": 0, "type": "number", "format": "double" }, "omdAmountToInvoiceForeign": { "minimum": 0, "type": "number", "format": "double" }, "omdAvalaraNonTaxReasonID": { "type": "string" }, "omdCreatedBy": { "type": "string" }, "omdCreatedDate": { "type": "string", "format": "date-time" }, "omdCustomerOrganizationID": { "type": "string" }, "omdDeliveryDate": { "type": "string", "format": "date-time" }, "omdDeliveryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omdDeliveryType": { "type": "integer", "format": "int32" }, "omdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omdExtendedWeight": { "minimum": 0, "type": "number", "format": "double" }, "omdFreightAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "omdFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omdClosed": { "type": "boolean" }, "omdDifferentLocation": { "type": "boolean" }, "omdFirm": { "type": "boolean" }, "omdInvoicedComplete": { "type": "boolean" }, "omdKitPart": { "type": "boolean" }, "omdPickInProgress": { "type": "boolean" }, "omdReceivedComplete": { "type": "boolean" }, "omdRequiresInspection": { "type": "boolean" }, "omdShippedComplete": { "type": "boolean" }, "omdPartBinID": { "type": "string" }, "omdPartID": { "type": "string" }, "omdPartRevisionID": { "type": "string" }, "omdPartWarehouseLocationID": { "type": "string" }, "omdPurchaseLocationID": { "type": "string" }, "omdPurchaseUnitCostBase": { "minimum": 0, "type": "number", "format": "double" }, "omdPurchaseUnitCostForeign": { "minimum": 0, "type": "number", "format": "double" }, "omdQuantityAllocated": { "minimum": 0, "type": "number", "format": "double" }, "omdQuantityInvoiced": { "minimum": 0, "type": "number", "format": "double" }, "omdQuantityOnOrder": { "minimum": 0, "type": "number", "format": "double" }, "omdQuantityReceived": { "minimum": 0, "type": "number", "format": "double" }, "omdQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "omdRowVersion": { "type": "integer", "format": "int64" }, "omdSalesOrderID": { "type": "string" }, "omdSalesOrderLineID": { "type": "integer", "format": "int32" }, "omdSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "omdShipContactID": { "type": "string" }, "omdShipLocationID": { "type": "string" }, "omdShippingMethodID": { "type": "string" }, "omdShippingPaymentTypeID": { "type": "string" }, "omdSupplierOrganizationID": { "type": "string" }, "omdWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPSalesOrderDeliveryDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderDeliveryDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderJobLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderJobLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderJobLinkDto": { "required": [ "omjJobID", "omjLinkType", "omjSalesOrderID", "omjSalesOrderLineID", "omjSalesOrderJobLinkID" ], "type": "object", "properties": { "omjCreatedBy": { "type": "string" }, "omjCreatedDate": { "type": "string", "format": "date-time" }, "omjUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omjClosed": { "type": "boolean" }, "omjJobID": { "type": "string" }, "omjLinkType": { "type": "integer", "format": "int32" }, "omjRowVersion": { "type": "integer", "format": "int64" }, "omjSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "omjSalesOrderID": { "type": "string" }, "omjSalesOrderLineID": { "type": "integer", "format": "int32" }, "omjSalesOrderJobLinkID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSalesOrderJobLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderJobLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderLineDto": { "required": [ "omlOrderQuantity", "omlPartID", "omlPartShortDescription", "omlSalesOrderID", "omlSalesOrderLineID" ], "type": "object", "properties": { "omlCreatedBy": { "type": "string" }, "omlCreatedDate": { "type": "string", "format": "date-time" }, "omlDeliveryQuantityTotal": { "minimum": 0, "type": "number", "format": "double" }, "omlDepositAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "omlDepositAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlDepositPercent": { "minimum": 0, "type": "number", "format": "double" }, "omlDiscountPercent": { "minimum": 0, "type": "number", "format": "double" }, "omlDocuments": { "type": "string" }, "omlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omlExtendedDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "omlExtendedDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlExtendedPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "omlExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlExtendedWeight": { "minimum": 0, "type": "number", "format": "double" }, "omlFreightAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "omlFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlFullExtendedPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "omlFullExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlFullUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "omlFullUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlAvalaraIgnoreLine": { "type": "boolean" }, "omlClosed": { "type": "boolean" }, "omlConfigured": { "type": "boolean" }, "omlDeposit": { "type": "boolean" }, "omlDepositCreated": { "type": "boolean" }, "omlDepositCredited": { "type": "boolean" }, "omlPayCommission": { "type": "boolean" }, "omlPriceOverride": { "type": "boolean" }, "omlTimeAndMaterial": { "type": "boolean" }, "omlLeadID": { "type": "string" }, "omlLeadLineID": { "type": "integer", "format": "int32" }, "omlNonTaxReasonID": { "type": "string" }, "omlOrderQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omlOrgPartID": { "type": "string" }, "omlOrgPartShortDescription": { "type": "string" }, "omlPartGroupID": { "type": "string" }, "omlPartID": { "type": "string" }, "omlPartLongDescriptionRtf": { "type": "string" }, "omlPartLongDescriptionText": { "type": "string" }, "omlPartRevisionID": { "type": "string" }, "omlPartShortDescription": { "type": "string" }, "omlProjectAreaID": { "type": "string" }, "omlProjectID": { "type": "string" }, "omlQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "omlQuoteID": { "type": "string" }, "omlQuoteLineID": { "type": "integer", "format": "int32" }, "omlQuoteQuantityID": { "type": "integer", "format": "int32" }, "omlReleaseNumber": { "type": "string" }, "omlRmaClaimID": { "type": "string" }, "omlRmaClaimLineID": { "type": "integer", "format": "int32" }, "omlRowVersion": { "type": "integer", "format": "int64" }, "omlSalesOrderID": { "type": "string" }, "omlSecondTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "omlSecondTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlSecondTaxCodeID": { "type": "string" }, "omlSalesOrderLineID": { "type": "integer", "format": "int32" }, "omlTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "omlTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlTaxCodeID": { "type": "string" }, "omlUnitDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "omlUnitDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlUnitOfMeasure": { "type": "string" }, "omlUnitPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "omlUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "omlWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPSalesOrderLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderMemoDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderMemoDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderMemoDto": { "required": [ "omkMemoDate", "omkSalesOrderID", "omkSalesOrderMemoID", "omkShortDescription" ], "type": "object", "properties": { "omkCreatedBy": { "type": "string" }, "omkCreatedDate": { "type": "string", "format": "date-time" }, "omkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omkClosed": { "type": "boolean" }, "omkLongDescriptionRtf": { "type": "string" }, "omkLongDescriptionText": { "type": "string" }, "omkMemoDate": { "type": "string", "format": "date-time" }, "omkRowVersion": { "type": "integer", "format": "int64" }, "omkSalesOrderID": { "type": "string" }, "omkSalesOrderMemoID": { "type": "integer", "format": "int32" }, "omkShortDescription": { "type": "string" }, "omkShowInArInvoices": { "type": "boolean" }, "omkShowInSalesOrders": { "type": "boolean" }, "omkShowInShipments": { "type": "boolean" } } }, "ERPResponseMessageDto[ERPSalesOrderMemoDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderMemoDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderPickListLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderPickListLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderPickListLineDto": { "required": [ "omyPickListLineID" ], "type": "object", "properties": { "omyCreatedBy": { "type": "string" }, "omyCreatedDate": { "type": "string", "format": "date-time" }, "omyDeliveryDate": { "type": "string", "format": "date-time" }, "omyUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omyOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omyPartBinID": { "type": "string" }, "omyPartID": { "type": "string" }, "omyPartRevisionID": { "type": "string" }, "omyPartWareHouseLocationID": { "type": "string" }, "omyPickDate": { "type": "string", "format": "date-time" }, "omyPickListLineID": { "type": "integer", "format": "int32" }, "omyPickListSessionID": { "type": "integer", "format": "int32" }, "omyPickQuantity": { "minimum": 0, "type": "number", "format": "double" }, "omyRowVersion": { "type": "integer", "format": "int64" }, "omySalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "omySalesOrderID": { "type": "string" }, "omySalesOrderLineID": { "type": "integer", "format": "int32" }, "omyStatus": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSalesOrderPickListLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderPickListLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderPickListSessionDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderPickListSessionDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderPickListSessionDto": { "required": [ "omsPickListSessionID", "omsSessionDate" ], "type": "object", "properties": { "omsCreatedBy": { "type": "string" }, "omsCreatedDate": { "type": "string", "format": "date-time" }, "omsDevice": { "type": "integer", "format": "int32" }, "omsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omsPullFromStockOnly": { "type": "boolean" }, "omsPickListSessionID": { "type": "integer", "format": "int32" }, "omsPlantDepartmentID": { "type": "string" }, "omsPlantID": { "type": "string" }, "omsPostedDate": { "type": "string", "format": "date-time" }, "omsRowVersion": { "type": "integer", "format": "int64" }, "omsSessionDate": { "type": "string", "format": "date-time" }, "omsStatus": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSalesOrderPickListSessionDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderPickListSessionDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderDto": { "required": [ "ompSalesOrderID", "ompCustomerOrganizationID", "ompOrderDate", "ompShipOrganizationID", "ompStatus" ], "type": "object", "properties": { "ompApprovalDecisionDate": { "type": "string", "format": "date-time" }, "ompApprovalRequestDate": { "type": "string", "format": "date-time" }, "ompArInvoiceContactID": { "type": "string" }, "ompArInvoiceLocationID": { "type": "string" }, "ompCallID": { "type": "string" }, "ompClosedDate": { "type": "string", "format": "date-time" }, "ompSalesOrderID": { "type": "string" }, "ompCreatedBy": { "type": "string" }, "ompCreatedDate": { "type": "string", "format": "date-time" }, "ompCurrencyRateID": { "type": "string" }, "ompCustomerOrganizationID": { "type": "string" }, "ompCustomerPo": { "type": "string" }, "ompDepositAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "ompDepositAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompDepositPercent": { "minimum": 0, "type": "number", "format": "double" }, "ompDiscountTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompDiscountTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ompExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "ompFedEx3rdPartyLocationID": { "type": "string" }, "ompFedEx3rdPartyOrganizationID": { "type": "string" }, "ompFedExAccountNumber": { "type": "string" }, "ompFedExBillingOption": { "type": "string" }, "ompFreeOnBoardDescription": { "type": "string" }, "ompFreightAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightTaxCodeID": { "type": "string" }, "ompFreightTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompFreightTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompFullOrderSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompFullOrderSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompAvalaraTaxCalculated": { "type": "boolean" }, "ompClosed": { "type": "boolean" }, "ompCreatedByEdi": { "type": "boolean" }, "ompCustomRate": { "type": "boolean" }, "ompDeposit": { "type": "boolean" }, "ompDepositCreated": { "type": "boolean" }, "ompReadyToPrint": { "type": "boolean" }, "ompNextApprovalEmployeeID": { "type": "string" }, "ompOrderCommentsRTF": { "type": "string" }, "ompOrderCommentsText": { "type": "string" }, "ompOrderDate": { "type": "string", "format": "date-time" }, "ompOrderSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompOrderSubTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompOrderTaxAmountBase": { "minimum": 0, "type": "number", "format": "double" }, "ompOrderTaxAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompOrderTotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompOrderTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompPaymentTermID": { "type": "string" }, "ompPlantDepartmentID": { "type": "string" }, "ompPlantID": { "type": "string" }, "ompProjectID": { "type": "string" }, "ompQuoteContactID": { "type": "string" }, "ompQuoteLocationID": { "type": "string" }, "ompRequestedShipDate": { "type": "string", "format": "date-time" }, "ompResellerContactID": { "type": "string" }, "ompResellerLocationID": { "type": "string" }, "ompResellerOrganizationID": { "type": "string" }, "ompRowVersion": { "type": "integer", "format": "int64" }, "ompSecondFreightTaxAmtBase": { "minimum": 0, "type": "number", "format": "double" }, "ompSecondFreightTaxAmtForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompSecondFreightTaxCodeID": { "type": "string" }, "ompShipContactID": { "type": "string" }, "ompShipLocationID": { "type": "string" }, "ompShipOrganizationID": { "type": "string" }, "ompShippingMethodID": { "type": "string" }, "ompShippingPaymentTypeID": { "type": "string" }, "ompSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "ompStandardMessageID": { "type": "string" }, "ompStatus": { "type": "integer", "format": "int32" }, "ompTaxSubtotalBase": { "minimum": 0, "type": "number", "format": "double" }, "ompTaxSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "ompTotalOrderWeight": { "minimum": 0, "type": "number", "format": "double" }, "ompUps3rdPartyLocationID": { "type": "string" }, "ompUps3rdPartyOrganizationID": { "type": "string" }, "ompUpsAccountNumber": { "type": "string" }, "ompUpsBillingOption": { "type": "string" } } }, "ERPResponseMessageDto[ERPSalesOrderDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPSalesOrderSalesPersonDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPSalesOrderSalesPersonDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPSalesOrderSalesPersonDto": { "required": [ "omiSalesEmployeeID", "omiSalesOrderID", "omiSequenceID" ], "type": "object", "properties": { "omiCreatedBy": { "type": "string" }, "omiCreatedDate": { "type": "string", "format": "date-time" }, "omiUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "omiClosed": { "type": "boolean" }, "omiPercent": { "minimum": 0, "type": "number", "format": "double" }, "omiRowVersion": { "type": "integer", "format": "int64" }, "omiSalesEmployeeID": { "type": "string" }, "omiSalesOrderID": { "type": "string" }, "omiSequenceID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPSalesOrderSalesPersonDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPSalesOrderSalesPersonDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPScheduleAllocationDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPScheduleAllocationDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPScheduleAllocationDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPScheduleAllocationDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPScheduleBranchDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPScheduleBranchDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPScheduleBranchDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPScheduleBranchDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPScheduleResourceLaneDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPScheduleResourceLaneDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPScheduleResourceLaneDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPScheduleResourceLaneDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPScheduleTaskBucketDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPScheduleTaskBucketDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPScheduleTaskBucketDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPScheduleTaskBucketDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPScheduleTaskDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPScheduleTaskDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPScheduleTaskDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPScheduleTaskDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPScheduleTreeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPScheduleTreeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPScheduleTreeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPScheduleTreeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDDFieldDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDDFieldDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPDDFieldDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDDFieldDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPDDTableDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPDDTableDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPDDTableDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPDDTableDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPIntegrationTransactionQueueDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPIntegrationTransactionQueueDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPIntegrationTransactionQueueDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPIntegrationTransactionQueueDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPCustomerPackageDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPCustomerPackageDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPCustomerPackageDto": { "required": [ "cpaCustomerPackageID", "cpaPackageDescription" ], "type": "object", "properties": { "cpaCustomerPackageID": { "type": "string" }, "cpaCreatedBy": { "type": "string" }, "cpaCreatedDate": { "type": "string", "format": "date-time" }, "cpaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "cpaInactiveDate": { "type": "string", "format": "date-time" }, "cpaInactive": { "type": "boolean" }, "cpaPackageDescription": { "type": "string" }, "cpaPackageDimensionsUom": { "type": "string" }, "cpaPackageHeight": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "cpaPackageLength": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "cpaPackageWidth": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "cpaRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPCustomerPackageDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPCustomerPackageDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFreightPackageLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFreightPackageLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPFreightPackageLinkDto": { "type": "object", "properties": { "fplCreatedBy": { "type": "string" }, "fplCreatedDate": { "type": "string", "format": "date-time" }, "fplUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fplFreightPackageID": { "type": "integer", "format": "int32" }, "fplFreightPackageLineID": { "type": "integer", "format": "int32" }, "fplFreightShipmentID": { "type": "string" }, "fplRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPFreightPackageLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFreightPackageLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFreightPackageRateDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFreightPackageRateDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPFreightPackageRateDto": { "type": "object", "properties": { "fprCreatedBy": { "type": "string" }, "fprCreatedDate": { "type": "string", "format": "date-time" }, "fprUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fprFdxBaseCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxCurrency": { "type": "string" }, "fprFdxDeliveryDate": { "type": "string", "format": "date-time" }, "fprFdxDeliveryDay": { "type": "string" }, "fprFdxDestinationStationID": { "type": "string" }, "fprFdxPackageBaseCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackageBillingWeight": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackageDimWeight": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackageFreightDiscount": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackageNetCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackageNetFreight": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackageSurcharges": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxPackaging": { "type": "string" }, "fprFdxService": { "type": "string" }, "fprFdxTimeInTransit": { "type": "integer", "format": "int32" }, "fprFdxTotalBillingWeight": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxTotalCustomerCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxTotalDimWeight": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxTotalFreightDiscount": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxTotalNetCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxTotalNetFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxTotalSurcharges": { "minimum": 0, "type": "number", "format": "double" }, "fprFdxUnits": { "type": "string" }, "fprFdxVariableHandlingCharge": { "minimum": 0, "type": "number", "format": "double" }, "fprFreightPackageID": { "type": "integer", "format": "int32" }, "fprFreightShipmentID": { "type": "string" }, "fprRCTI": { "type": "string" }, "fprRowVersion": { "type": "integer", "format": "int64" }, "fprFreightPackageRateID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPFreightPackageRateDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFreightPackageRateDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFreightPackageDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFreightPackageDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPFreightPackageDto": { "required": [ "fslFreightShipmentID", "fslPackageFullWeight", "fslFreightPackageID" ], "type": "object", "properties": { "fslCreatedBy": { "type": "string" }, "fslCreatedDate": { "type": "string", "format": "date-time" }, "fslDimensionsUnitOfMeasure": { "type": "string" }, "fslDistributeCostsOption": { "type": "integer", "format": "int32" }, "fslUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fslFdxPackageHeight": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "fslFdxPackageLength": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "fslFdxPackageWidth": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "fslFdxPackaging": { "type": "string" }, "fslFreightShipmentID": { "type": "string" }, "fslFdxNonstandardContainer": { "type": "boolean" }, "fslVoidOnUps": { "type": "boolean" }, "fslNotesRTF": { "type": "string" }, "fslNotesText": { "type": "string" }, "fslPackageCharge": { "minimum": 0, "type": "number", "format": "double" }, "fslPackageFullWeight": { "minimum": 0, "type": "number", "format": "double" }, "fslPackagePublishedCharge": { "minimum": 0, "type": "number", "format": "double" }, "fslRowVersion": { "type": "integer", "format": "int64" }, "fslFreightPackageID": { "type": "integer", "format": "int32" }, "fslTrackingNumber": { "type": "string" }, "fslUpsPackageType": { "type": "string" }, "fslWeightUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPFreightPackageDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFreightPackageDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFreightReferenceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFreightReferenceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPFreightReferenceDto": { "required": [ "frcFreightReferenceID", "frcFreightShipmentID" ], "type": "object", "properties": { "frcFreightReferenceID": { "type": "string" }, "frcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "frcFreightShipmentID": { "type": "string" }, "frcQuoteID": { "type": "string" }, "frcRowVersion": { "type": "integer", "format": "int64" }, "frcShipmentID": { "type": "string" } } }, "ERPResponseMessageDto[ERPFreightReferenceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFreightReferenceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPFreightShipmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPFreightShipmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPFreightShipmentDto": { "required": [ "fspFreightShipmentID", "fspShipFromOrganizationID", "fspShipOrganizationID" ], "type": "object", "properties": { "fspCarrier": { "type": "string" }, "fspFreightShipmentID": { "type": "string" }, "fspCreatedBy": { "type": "string" }, "fspCreatedDate": { "type": "string", "format": "date-time" }, "fspDeclaredValue": { "minimum": 0, "type": "number", "format": "double" }, "fspDistributeCostsOption": { "type": "integer", "format": "int32" }, "fspUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fspFdxAccessibility": { "type": "string" }, "fspFdxCodCollectionAmount": { "minimum": 0, "type": "number", "format": "double" }, "fspFdxCodCollectionType": { "type": "string" }, "fspFdxDropOffType": { "type": "string" }, "fspFdxHandlingCost": { "minimum": 0, "type": "number", "format": "double" }, "fspFdxHomeDeliveryType": { "type": "string" }, "fspFdxLastLogID": { "type": "integer", "format": "int32" }, "fspFdxLastReplyErrorCode": { "type": "string" }, "fspFdxLastReplyErrorMessage": { "type": "string" }, "fspFdxLastReplySoftErrorCode": { "type": "string" }, "fspFdxLastReplySoftErrorMsg": { "type": "string" }, "fspFdxLastReplySoftErrorType": { "type": "string" }, "fspFdxLastRequestDate": { "type": "string", "format": "date-time" }, "fspFdxLastUTI": { "type": "string" }, "fspFdxPackagingCost": { "minimum": 0, "type": "number", "format": "double" }, "fspFdxPayorAccountNumber": { "type": "string" }, "fspFdxPayorCountryCode": { "type": "string" }, "fspFdxPayorType": { "type": "string" }, "fspFdxRateRequestType": { "type": "string" }, "fspFdxReturnShipIndicator": { "type": "string" }, "fspFdxService": { "type": "string" }, "fspFdxShipCostMarkupPct": { "minimum": 0, "type": "number", "format": "double" }, "fspFdxSignatureOption": { "type": "string" }, "fspFdxSignatureReleaseAuthNum": { "type": "string" }, "fspFdxStatus": { "type": "integer", "format": "int32" }, "fspFdxStatusText": { "type": "string" }, "fspFdxVHCAmountOrPercentage": { "minimum": 0, "type": "number", "format": "double" }, "fspFdxVHCLevel": { "type": "string" }, "fspFdxVHCType": { "type": "string" }, "fspFreightShipmentDate": { "type": "string", "format": "date-time" }, "fspFdxCod": { "type": "boolean" }, "fspFdxHoldAtLocation": { "type": "boolean" }, "fspFdxInsideDelivery": { "type": "boolean" }, "fspFdxInsidePickup": { "type": "boolean" }, "fspFdxOneItemPerShipment": { "type": "boolean" }, "fspFdxSaturdayDelivery": { "type": "boolean" }, "fspFdxSaturdayPickup": { "type": "boolean" }, "fspUpsSaturdayDelivery": { "type": "boolean" }, "fspVoidOnUps": { "type": "boolean" }, "fspNotesRTF": { "type": "string" }, "fspNotesText": { "type": "string" }, "fspRowVersion": { "type": "integer", "format": "int64" }, "fspShipFromOrganizationID": { "type": "string" }, "fspShipLocationID": { "type": "string" }, "fspShipOrganizationID": { "type": "string" }, "fspShipperAcctNumber": { "type": "string" }, "fspShippingMethodID": { "type": "string" }, "fspTotalCharges": { "minimum": 0, "type": "number", "format": "double" }, "fspTotalPublishedCharges": { "minimum": 0, "type": "number", "format": "double" }, "fspUps3rdPartyLocationID": { "type": "string" }, "fspUps3rdPartyOrganizationID": { "type": "string" }, "fspUpsBillAcctNumber": { "type": "string" }, "fspUpsBillingOption": { "type": "string" }, "fspUpsInterfaceStatus": { "type": "integer", "format": "int32" }, "fspUpsServiceType": { "type": "string" } } }, "ERPResponseMessageDto[ERPFreightShipmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPFreightShipmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentComponentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentComponentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentComponentDto": { "required": [ "smoPartBinID", "smoPartID", "smoPartWarehouseLocationID", "smoShipmentComponentID", "smoShipmentID", "smoShipmentLineID" ], "type": "object", "properties": { "smoAdditionalQuantity": { "minimum": 0, "type": "number", "format": "double" }, "smoCreatedBy": { "type": "string" }, "smoCreatedDate": { "type": "string", "format": "date-time" }, "smoDescription": { "type": "string" }, "smoUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smoClosed": { "type": "boolean" }, "smoPostedToGl": { "type": "boolean" }, "smoReversed": { "type": "boolean" }, "smoShippedComplete": { "type": "boolean" }, "smoJobID": { "type": "string" }, "smoJobParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "smoJobQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "smoParentQuantity": { "minimum": 0, "type": "number", "format": "double" }, "smoPartBinID": { "type": "string" }, "smoPartID": { "type": "string" }, "smoPartRevisionID": { "type": "string" }, "smoPartWarehouseLocationID": { "type": "string" }, "smoQuantityPerParent": { "minimum": 0, "type": "number", "format": "double" }, "smoQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "smoReverseShipmentComponentID": { "type": "integer", "format": "int32" }, "smoReverseShipmentID": { "type": "string" }, "smoReverseShipmentLineID": { "type": "integer", "format": "int32" }, "smoRowVersion": { "type": "integer", "format": "int64" }, "smoSalesOrderComponentID": { "type": "integer", "format": "int32" }, "smoSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "smoSalesOrderID": { "type": "string" }, "smoSalesOrderLineID": { "type": "integer", "format": "int32" }, "smoShipmentComponentID": { "type": "integer", "format": "int32" }, "smoShipmentID": { "type": "string" }, "smoShipmentLineID": { "type": "integer", "format": "int32" }, "smoSourceTableName": { "type": "string" }, "smoSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smoUnitOfMeasure": { "type": "string" }, "smoWeight": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPShipmentComponentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentComponentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[ERPShipmentFreightLinkDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentFreightLinkDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentFreightLinkDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentFreightLinkDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentFreightLinkDto": { "required": [ "smxFreightPackageID", "smxFreightShipmentID", "smxShipmentFreightLinkID", "smxShipmentID", "smxShipmentLineID" ], "type": "object", "properties": { "smxCreatedBy": { "type": "string" }, "smxCreatedDate": { "type": "string", "format": "date-time" }, "smxUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smxFreightCharges": { "minimum": 0, "type": "number", "format": "double" }, "smxFreightPackageID": { "type": "integer", "format": "int32" }, "smxFreightShipmentID": { "type": "string" }, "smxClosed": { "type": "boolean" }, "smxLinkPctCharge": { "minimum": 0, "type": "number", "format": "double" }, "smxPackagePartialCount": { "minimum": 0, "type": "number", "format": "double" }, "smxPackagePartialWeight": { "minimum": 0, "type": "number", "format": "double" }, "smxRowVersion": { "type": "integer", "format": "int64" }, "smxShipmentFreightLinkID": { "type": "integer", "format": "int32" }, "smxShipmentID": { "type": "string" }, "smxShipmentLineID": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentFreightReferenceDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentFreightReferenceDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentFreightReferenceDto": { "required": [ "smrFreightShipmentID", "smrShipmentFreightReferenceID", "smrShipmentID" ], "type": "object", "properties": { "smrCreatedBy": { "type": "string" }, "smrCreatedDate": { "type": "string", "format": "date-time" }, "smrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smrFreightShipmentID": { "type": "string" }, "smrRowVersion": { "type": "integer", "format": "int64" }, "smrShipmentFreightReferenceID": { "type": "integer", "format": "int32" }, "smrShipmentID": { "type": "string" } } }, "ERPResponseMessageDto[ERPShipmentFreightReferenceDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentFreightReferenceDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentLineDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentLineDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentLineDto": { "required": [ "smlPartBinID", "smlPartID", "smlPartWarehouseLocationID", "smlShipmentLineID", "smlShipmentID" ], "type": "object", "properties": { "smlCreatedBy": { "type": "string" }, "smlCreatedDate": { "type": "string", "format": "date-time" }, "smlDescription": { "type": "string" }, "smlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smlExtendedPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "smlExtendedPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "smlExtendedWeight": { "minimum": 0, "type": "number", "format": "double" }, "smlFreightAmount": { "minimum": 0, "type": "number", "format": "double" }, "smlFreightAmountForeign": { "minimum": 0, "type": "number", "format": "double" }, "smlHeatLot": { "type": "string" }, "smlClosed": { "type": "boolean" }, "smlInvoicedComplete": { "type": "boolean" }, "smlKitPart": { "type": "boolean" }, "smlOverridePrice": { "type": "boolean" }, "smlPostedToGl": { "type": "boolean" }, "smlRequiresInspection": { "type": "boolean" }, "smlReversed": { "type": "boolean" }, "smlShippedComplete": { "type": "boolean" }, "smlWMSPickInProgress": { "type": "boolean" }, "smlJobID": { "type": "string" }, "smlJobQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "smlOrgPartID": { "type": "string" }, "smlOrgPartShortDescription": { "type": "string" }, "smlPartBinID": { "type": "string" }, "smlPartGroupID": { "type": "string" }, "smlPartID": { "type": "string" }, "smlPartLongDescriptionRtf": { "type": "string" }, "smlPartLongDescriptionText": { "type": "string" }, "smlPartRevisionID": { "type": "string" }, "smlPartWarehouseLocationID": { "type": "string" }, "smlProjectAreaID": { "type": "string" }, "smlProjectID": { "type": "string" }, "smlQuantityShipped": { "minimum": 0, "type": "number", "format": "double" }, "smlReverseShipmentID": { "type": "string" }, "smlReverseShipmentLineID": { "type": "integer", "format": "int32" }, "smlRowVersion": { "type": "integer", "format": "int64" }, "smlSalesOrderDeliveryID": { "type": "integer", "format": "int32" }, "smlSalesOrderID": { "type": "string" }, "smlSalesOrderLineID": { "type": "integer", "format": "int32" }, "smlShipmentLineID": { "type": "integer", "format": "int32" }, "smlShipmentID": { "type": "string" }, "smlShipmentIDNumber": { "type": "string" }, "smlSODeliveryQuantity": { "minimum": 0, "type": "number", "format": "double" }, "smlSOOpenQuantity": { "minimum": 0, "type": "number", "format": "double" }, "smlSourceTableName": { "type": "string" }, "smlSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smlUnitOfMeasure": { "type": "string" }, "smlUnitPrice": { "minimum": 0, "type": "number", "format": "double" }, "smlUnitPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "smlWeight": { "minimum": 0, "type": "number", "format": "double" }, "smlWeightUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPShipmentLineDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentLineDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentPackageDetailDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentPackageDetailDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentPackageDetailDto": { "required": [ "spdShipmentPackageID" ], "type": "object", "properties": { "spdCommodityDescription": { "type": "string" }, "spdCountryOfManufacture": { "type": "string" }, "spdCreatedBy": { "type": "string" }, "spdCreatedDate": { "type": "string", "format": "date-time" }, "spdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "spdPartID": { "type": "string" }, "spdPartRevisionID": { "type": "string" }, "spdQuantity": { "minimum": 0, "type": "number", "format": "double" }, "spdRowVersion": { "type": "integer", "format": "int64" }, "spdShipmentID": { "type": "string" }, "spdShipmentIDNumber": { "type": "string" }, "spdShipmentLineID": { "type": "integer", "format": "int32" }, "spdShipmentPackageID": { "type": "integer", "format": "int32" }, "spdShipmentPackageLineID": { "type": "integer", "format": "int32" }, "spdTotalPriceBase": { "minimum": 0, "type": "number", "format": "double" }, "spdTotalPriceForeign": { "minimum": 0, "type": "number", "format": "double" }, "spdWeight": { "minimum": 0, "type": "number", "format": "double" }, "spdWeightUnitOfMeasure": { "type": "string" } } }, "ERPResponseMessageDto[ERPShipmentPackageDetailDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentPackageDetailDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentPackageDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentPackageDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentPackageDto": { "type": "object", "properties": { "spaCarrier": { "type": "string" }, "spaCreatedBy": { "type": "string" }, "spaCreatedDate": { "type": "string", "format": "date-time" }, "spaCustomerPackageID": { "type": "string" }, "spaEdi856CustomLabel": { "type": "string" }, "spaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "spaFedExPackageTypes": { "type": "string" }, "spaAdditionalHandlingRequired": { "type": "boolean" }, "spaLargePackage": { "type": "boolean" }, "spaVerbalConfirmationRequired": { "type": "boolean" }, "spaLabelFilePath": { "type": "string" }, "spaPackageDimensionsUom": { "type": "string" }, "spaPackageHeight": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "spaPackageLength": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "spaPackageRate": { "minimum": 0, "type": "number", "format": "double" }, "spaPackageRateForeign": { "minimum": 0, "type": "number", "format": "double" }, "spaPackageValue": { "minimum": 0, "type": "number", "format": "double" }, "spaPackageValueForeign": { "minimum": 0, "type": "number", "format": "double" }, "spaPackageWeight": { "minimum": 0, "type": "number", "format": "double" }, "spaPackageWeightUom": { "type": "string" }, "spaPackageWidth": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "spaReference1": { "type": "string" }, "spaReference2": { "type": "string" }, "spaRowVersion": { "type": "integer", "format": "int64" }, "spaShipmentPackageID": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "spaShipmentID": { "type": "string" }, "spaShipmentIDNumber": { "type": "string" }, "spaShippingMethodID": { "type": "string" }, "spaTrackingNo": { "type": "string" }, "spaUpsPackageTypes": { "type": "string" } } }, "ERPResponseMessageDto[ERPShipmentPackageDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentPackageDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShipmentDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShipmentDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShipmentDto": { "required": [ "smpShipmentID", "smpCustomerOrganizationID", "smpShipDate", "smpShipOrganizationID" ], "type": "object", "properties": { "smpAccBaseChargeBase": { "minimum": 0, "type": "number", "format": "double" }, "smpAccBaseChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpAccCarrierFreightBase": { "minimum": 0, "type": "number", "format": "double" }, "smpAccCarrierFreightForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpAccDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "smpAccDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpAccSurchargeBase": { "minimum": 0, "type": "number", "format": "double" }, "smpAccSurchargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpAdditionalWeight": { "minimum": 0, "type": "number", "format": "double" }, "smpAESITN": { "type": "string" }, "smpArInvoiceContactID": { "type": "string" }, "smpArInvoiceLocationID": { "type": "string" }, "smpBlindShipContactID": { "type": "string" }, "smpBlindShipLocationID": { "type": "string" }, "smpBlindShipOrganizationID": { "type": "string" }, "smpCarrierDocumentFilePath": { "type": "string" }, "smpClosedDate": { "type": "string", "format": "date-time" }, "smpShipmentID": { "type": "string" }, "smpCodLabelFilePath": { "type": "string" }, "smpCreatedBy": { "type": "string" }, "smpCreatedDate": { "type": "string", "format": "date-time" }, "smpCurrencyRateID": { "type": "string" }, "smpCustomerOrganizationID": { "type": "string" }, "smpDocuments": { "type": "string" }, "smpEdiTransferredDate": { "type": "string", "format": "date-time" }, "smpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "smpExchangeRate": { "minimum": 0, "type": "number", "format": "double" }, "smpExportingCarrier": { "type": "string" }, "smpFedEx3rdPartyLocationID": { "type": "string" }, "smpFedEx3rdPartyOrganizationID": { "type": "string" }, "smpFedExAccountNumber": { "type": "string" }, "smpFedExBillingOption": { "type": "string" }, "smpFreightCharge": { "minimum": 0, "type": "number", "format": "double" }, "smpFreightChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpFreightSubtotal": { "minimum": 0, "type": "number", "format": "double" }, "smpFreightSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpFreightTotal": { "minimum": 0, "type": "number", "format": "double" }, "smpFreightTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpClosed": { "type": "boolean" }, "smpCustomRate": { "type": "boolean" }, "smpEdiShipmentReady": { "type": "boolean" }, "smpEdiTransferred": { "type": "boolean" }, "smpFlaggedforWMS": { "type": "boolean" }, "smpPostedToGl": { "type": "boolean" }, "smpPrintLabels": { "type": "boolean" }, "smpPrintPackingSlip": { "type": "boolean" }, "smpReversalEntry": { "type": "boolean" }, "smpReversed": { "type": "boolean" }, "smpListBaseChargeBase": { "minimum": 0, "type": "number", "format": "double" }, "smpListBaseChargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpListCarrierFreightBase": { "minimum": 0, "type": "number", "format": "double" }, "smpListCarrierFreightForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpListDiscountBase": { "minimum": 0, "type": "number", "format": "double" }, "smpListDiscountForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpListSurchargeBase": { "minimum": 0, "type": "number", "format": "double" }, "smpListSurchargeForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpNumberOfLabels": { "type": "integer", "format": "int32" }, "smpPlantDepartmentID": { "type": "string" }, "smpPlantID": { "type": "string" }, "smpPostedDate": { "type": "string", "format": "date-time" }, "smpProjectID": { "type": "string" }, "smpReasonForExport": { "type": "string" }, "smpReturnInstructionsRTF": { "type": "string" }, "smpReturnInstructionsText": { "type": "string" }, "smpRowVersion": { "type": "integer", "format": "int64" }, "smpShipContactID": { "type": "string" }, "smpShipDate": { "type": "string", "format": "date-time" }, "smpShipLocationID": { "type": "string" }, "smpShipmentIDNumber": { "type": "string" }, "smpShipmentSubtotal": { "minimum": 0, "type": "number", "format": "double" }, "smpShipmentSubtotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpShipmentTotal": { "minimum": 0, "type": "number", "format": "double" }, "smpShipmentTotalForeign": { "minimum": 0, "type": "number", "format": "double" }, "smpShipOrganizationID": { "type": "string" }, "smpShippingCommentsRTF": { "type": "string" }, "smpShippingCommentsText": { "type": "string" }, "smpShippingMethodID": { "type": "string" }, "smpShippingPaymentTypeID": { "type": "string" }, "smpStandardMessageID": { "type": "string" }, "smpTrackingNumber": { "type": "string" }, "smpUps3rdPartyLocationID": { "type": "string" }, "smpUps3rdPartyOrganizationID": { "type": "string" }, "smpUpsAccountNumber": { "type": "string" }, "smpUpsBillingOption": { "type": "string" }, "smpWeightSubtotal": { "minimum": 0, "type": "number", "format": "double" }, "smpWeightTotal": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPResponseMessageDto[ERPShipmentDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShipmentDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShippingMethodDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShippingMethodDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShippingMethodDto": { "required": [ "xasShippingMethodID", "xasDescription" ], "type": "object", "properties": { "xasAvalaraTaxCodeID": { "type": "string" }, "xasCarrier": { "type": "string" }, "xasCarrierAccountNumber": { "type": "string" }, "xasShippingMethodID": { "type": "string" }, "xasCreatedBy": { "type": "string" }, "xasCreatedDate": { "type": "string", "format": "date-time" }, "xasDescription": { "type": "string" }, "xasDistributeCostsOption": { "type": "integer", "format": "int32" }, "xasUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xasFdxAccessibility": { "type": "string" }, "xasFdxCodCollectionType": { "type": "string" }, "xasFdxDropOffType": { "type": "string" }, "xasFdxHomeDeliveryType": { "type": "string" }, "xasFdxPackageType": { "type": "string" }, "xasFdxRateElementBasis": { "type": "string" }, "xasFdxRateRequestType": { "type": "string" }, "xasFdxRateTypeBasis": { "type": "string" }, "xasFdxReturnShipIndicator": { "type": "string" }, "xasFdxService": { "type": "string" }, "xasFdxSignatureOption": { "type": "string" }, "xasFdxVHCAmountOrPercentage": { "minimum": 0, "type": "number", "format": "double" }, "xasFdxVHCLevel": { "type": "string" }, "xasFdxVHCType": { "type": "string" }, "xasFedExBillingOption": { "type": "string" }, "xasInactiveDate": { "type": "string", "format": "date-time" }, "xasInactive": { "type": "boolean" }, "xasFdxCertificateOfOrigin": { "type": "boolean" }, "xasFdxCod": { "type": "boolean" }, "xasFdxCommercialInvoice": { "type": "boolean" }, "xasFdxExportDeclaration": { "type": "boolean" }, "xasFdxHoldAtLocation": { "type": "boolean" }, "xasFdxInsideDelivery": { "type": "boolean" }, "xasFdxInsidePickup": { "type": "boolean" }, "xasFdxNAFTACO": { "type": "boolean" }, "xasFdxNonStandardContainer": { "type": "boolean" }, "xasFdxReturnInstructions": { "type": "boolean" }, "xasFdxSaturdayDelivery": { "type": "boolean" }, "xasFdxSaturdayPickup": { "type": "boolean" }, "xasUpsCertificateOfOrigin": { "type": "boolean" }, "xasUpsCod": { "type": "boolean" }, "xasUpsCommercialInvoice": { "type": "boolean" }, "xasUpsNAFTACO": { "type": "boolean" }, "xasUpsPackingList": { "type": "boolean" }, "xasUpsPartialInvoice": { "type": "boolean" }, "xasUpsSaturdayDelivery": { "type": "boolean" }, "xasUpsUseInterface": { "type": "boolean" }, "xasReferenceTrackingLink": { "type": "string" }, "xasRowVersion": { "type": "integer", "format": "int64" }, "xasSecondTaxCodeID": { "type": "string" }, "xasShipChargeWeb": { "minimum": 0, "type": "number", "format": "double" }, "xasShippingPaymentTypeID": { "type": "string" }, "xasTaxCodeID": { "type": "string" }, "xasTaxStatus": { "type": "integer", "format": "int32" }, "xasTrackingLink": { "type": "string" }, "xasUpsBillingOptionDefault": { "type": "string" }, "xasUpsCodFundsCode": { "type": "string" }, "xasUpsCostCenter": { "type": "string" }, "xasUpsPackageType": { "type": "string" }, "xasUpsServiceType": { "type": "string" }, "xasUpsWsBillingOption": { "type": "string" }, "xasUpsWSPackageType": { "type": "string" }, "xasUpsWSServiceType": { "type": "string" }, "xasUSPSEndorsement": { "type": "string" } } }, "ERPResponseMessageDto[ERPShippingMethodDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShippingMethodDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPResponseMessageDto[IList[ERPShippingPaymentTypeDto]]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "type": "array", "items": { "$ref": "#/components/schemas/ERPShippingPaymentTypeDto" } }, "recordCount": { "type": "integer", "format": "int32" } } }, "ERPShippingPaymentTypeDto": { "required": [ "xayShippingPaymentTypeID", "xayDescription" ], "type": "object", "properties": { "xayShippingPaymentTypeID": { "type": "string" }, "xayCreatedBy": { "type": "string" }, "xayCreatedDate": { "type": "string", "format": "date-time" }, "xayDescription": { "type": "string" }, "xayUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xayInactiveDate": { "type": "string", "format": "date-time" }, "xayInactive": { "type": "boolean" }, "xayDoNotXferShipCostsToAr": { "type": "boolean" }, "xayRowVersion": { "type": "integer", "format": "int64" } } }, "ERPResponseMessageDto[ERPShippingPaymentTypeDto]": { "type": "object", "properties": { "responseInfo": { "$ref": "#/components/schemas/APIResponseMessageDto" }, "returnObject": { "$ref": "#/components/schemas/ERPShippingPaymentTypeDto" }, "recordCount": { "type": "integer", "format": "int32" } } }, "PartClassDto": { "required": [ "partClassID", "description" ], "type": "object", "properties": { "partClassID": { "type": "string" }, "description": { "type": "string" } } }, "Error": { "type": "object", "properties": { "innerText": { "type": "string" } } }, "Warning": { "type": "object", "properties": { "innerText": { "type": "string" } } }, "PartGroupDto": { "required": [ "partGroupID", "description" ], "type": "object", "properties": { "partGroupID": { "type": "string" }, "description": { "type": "string" } } }, "ProcessDto": { "required": [ "processID", "shortDescription" ], "type": "object", "properties": { "processID": { "type": "string" }, "shortDescription": { "type": "string" } } }, "WorkCenterDto": { "required": [ "workCenterID", "description" ], "type": "object", "properties": { "workCenterID": { "type": "string" }, "description": { "type": "string" } } }, "WarehouseDto": { "required": [ "warehouseID", "name" ], "type": "object", "properties": { "warehouseID": { "type": "string" }, "name": { "type": "string" }, "plantID": { "type": "string" }, "defaultWarehouse": { "type": "boolean" } } }, "WarehouseBinDto": { "required": [ "warehouseID", "warehouseBinID", "description" ], "type": "object", "properties": { "warehouseID": { "type": "string" }, "warehouseBinID": { "type": "string" }, "description": { "type": "string" }, "defaultBin": { "type": "boolean" } } }, "BOMJobGuidDto": { "type": "object", "properties": { "jobId": { "type": "string" }, "jobGuid": { "type": "string" }, "partId": { "type": "string" }, "partGuid": { "type": "string" } } }, "CTMBOMJobMethodAssemblyDto": { "type": "object", "properties": { "jobAssembly": { "$ref": "#/components/schemas/BOMJobAssemblyDto" }, "jobOperations": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobOperationDto" } }, "jobMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/BOMJobMaterialDto" } } } }, "APSJobOperationDto": { "required": [ "workCenterID", "schedStartDate" ], "type": "object", "properties": { "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "workCenterID": { "type": "string" }, "schedStartDate": { "type": "string", "format": "date-time" }, "schedEndDate": { "type": "string", "format": "date-time" } } }, "CTMAPSJobDto": { "type": "object", "properties": { "jobID": { "type": "string" }, "plantID": { "type": "string" }, "productionDueDate": { "type": "string", "format": "date-time" }, "customerOrganizationID": { "type": "string" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWareHouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "jobPriorityID": { "type": "integer", "format": "int32" }, "unitOfMeasure": { "type": "string" }, "orderQuantity": { "type": "number", "format": "double" }, "inventoryQuantity": { "type": "number", "format": "double" }, "scrapQuantity": { "type": "number", "format": "double" }, "scrapQuantityCompleted": { "type": "number", "format": "double" }, "reworkQuantity": { "type": "number", "format": "double" }, "reworkDate": { "type": "string", "format": "date-time" }, "productionQuantity": { "type": "number", "format": "double" }, "planningComplete": { "type": "boolean" }, "scheduleComplete": { "type": "boolean" }, "productionComplete": { "type": "boolean" }, "releasedToFloor": { "type": "boolean" }, "closed": { "type": "boolean" }, "projectAreaID": { "type": "string" }, "projectID": { "type": "string" }, "partForecastPeriodID": { "type": "integer", "format": "int32" }, "partForecastYearID": { "type": "integer", "format": "int32" }, "firm": { "type": "boolean" }, "quantityShipped": { "type": "number", "format": "double" }, "quantityReceivedToInventory": { "type": "number", "format": "double" }, "nestlinkProcessed": { "type": "boolean" }, "scheduledDueDate": { "type": "string", "format": "date-time" }, "plannerEmployeeID": { "type": "string" }, "quantityCompleted": { "type": "number", "format": "double" }, "completedDate": { "type": "string", "format": "date-time" }, "closedDate": { "type": "string", "format": "date-time" }, "scheduledStartDate": { "type": "string", "format": "date-time" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rowVersion": { "type": "string", "format": "byte" }, "jobDate": { "type": "string", "format": "date-time" }, "partShortDescription": { "type": "string" }, "onhold": { "type": "boolean" }, "joboperations": { "type": "array", "items": { "$ref": "#/components/schemas/CTMAPSJobOperationDto" } } } }, "BOMPartRevisionDto": { "required": [ "partID", "shortDescription" ], "type": "object", "properties": { "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "shortDescription": { "type": "string" }, "inventoryUnitOfMeasure": { "type": "string" }, "purchaseUnitOfMeasure": { "type": "string" }, "supplierOrganizationID": { "type": "string" }, "conversionFactor": { "type": "number", "format": "double" }, "effectiveStartDate": { "type": "string", "format": "date-time" }, "leadTime": { "type": "integer", "format": "int32" }, "effectiveEndDate": { "type": "string", "format": "date-time" }, "purchaseLocationID": { "type": "string" }, "averageLaborCost": { "type": "number", "format": "double" }, "averageOverheadCost": { "type": "number", "format": "double" }, "averageMaterialCost": { "type": "number", "format": "double" }, "averageSubcontractCost": { "type": "number", "format": "double" }, "lastLaborCost": { "type": "number", "format": "double" }, "lastOverheadCost": { "type": "number", "format": "double" }, "lastMaterialCost": { "type": "number", "format": "double" }, "lastSubcontractCost": { "type": "number", "format": "double" }, "standardLaborCost": { "type": "number", "format": "double" }, "standardOverheadCost": { "type": "number", "format": "double" }, "standardMaterialCost": { "type": "number", "format": "double" }, "standardSubcontractCost": { "type": "number", "format": "double" }, "averageDutyCost": { "type": "number", "format": "double" }, "averageFreightCost": { "type": "number", "format": "double" }, "averageMiscCost": { "type": "number", "format": "double" }, "lastDutyCost": { "type": "number", "format": "double" }, "lastFreightCost": { "type": "number", "format": "double" }, "lastMiscCost": { "type": "number", "format": "double" }, "standardDutyCost": { "type": "number", "format": "double" }, "standardFreightCost": { "type": "number", "format": "double" }, "standardMiscCost": { "type": "number", "format": "double" }, "longDescription": { "type": "string" }, "lastTransactionDate": { "type": "string", "format": "date-time" }, "manufacturingLotSize": { "type": "number", "format": "double" }, "inactive": { "type": "boolean" }, "lastReceiptDate": { "type": "string", "format": "date-time" }, "requiresInspection": { "type": "boolean" }, "expenseSplitPercentTotal": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "weightUnitOfMeasure": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "averageUnitCost": { "type": "number", "format": "double" }, "standardUnitCost": { "type": "number", "format": "double" }, "lastUnitCost": { "type": "number", "format": "double" }, "sheetSizeX": { "type": "number", "format": "double" }, "sheetSizeY": { "type": "number", "format": "double" }, "barLength": { "type": "number", "format": "double" }, "thickness": { "type": "number", "format": "double" } } }, "BOMPartMethodAssemblyDto": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/BOMPartAssemblyDto" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartOperationDto" } }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/BOMPartMaterialDto" } } } }, "CTMBOMPartMethodGuidDto": { "type": "object", "properties": { "partId": { "type": "string" }, "partGuid": { "type": "string" }, "partRevisionGuids": { "type": "array", "items": { "$ref": "#/components/schemas/CTMBOMPartRevisionGuidDto" } } } }, "ERPCallTypeDto": { "required": [ "kbtCallTypeID", "kbtDescription" ], "type": "object", "properties": { "kbtCallStatus": { "type": "string" }, "kbtCallTypeID": { "type": "string" }, "kbtCreatedBy": { "type": "string" }, "kbtCreatedDate": { "type": "string", "format": "date-time" }, "kbtDescription": { "type": "string" }, "kbtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbtInactiveDate": { "type": "string", "format": "date-time" }, "kbtInactive": { "type": "boolean" }, "kbtBillableCall": { "type": "boolean" }, "kbtFieldServiceCall": { "type": "boolean" }, "kbtInboundCall": { "type": "boolean" }, "kbtInternalOnlyCall": { "type": "boolean" }, "kbtRowVersion": { "type": "integer", "format": "int64" } } }, "ERPServiceContractTypeDto": { "required": [ "kbyServiceContractTypeID", "kbyDescription" ], "type": "object", "properties": { "kbyServiceContractTypeID": { "type": "string" }, "kbyCreatedBy": { "type": "string" }, "kbyCreatedDate": { "type": "string", "format": "date-time" }, "kbyDescription": { "type": "string" }, "kbyUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "kbyInactiveDate": { "type": "string", "format": "date-time" }, "kbyInactive": { "type": "boolean" }, "kbyRowVersion": { "type": "integer", "format": "int64" } } }, "MesTimecardLineDto": { "type": "object", "properties": { "jobID": { "type": "string" }, "erpJobOperationId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "elapsedTime": { "type": "number", "format": "double" }, "setupTime": { "type": "number", "format": "double" }, "machineHours": { "type": "number", "format": "double" }, "laborHours": { "type": "number", "format": "double" }, "processID": { "type": "string" }, "workCenterID": { "type": "string" }, "goodQty": { "type": "number", "format": "double" }, "scrapQty": { "type": "number", "format": "double" }, "comments": { "type": "string" } } }, "MesIntegrationTransactionQueueInformationDto": { "type": "object", "properties": { "itqApIAction": { "type": "string" }, "itqCreatedBy": { "type": "string" }, "itqCreatedDate": { "type": "string", "format": "date-time" }, "itqEntityType": { "type": "string" }, "itqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "itqErrorCode": { "type": "string" }, "itqErrorMessage": { "type": "string" }, "itqIntegrationType": { "type": "string" }, "itqNextRetryTime": { "type": "string", "format": "date-time" }, "itqParentUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "itqRequest": { "type": "string" }, "itqResponse": { "type": "string" }, "itqRetryCount": { "type": "integer", "format": "int32" }, "itqSourceTableName": { "type": "string" }, "itqSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "itqStatus": { "type": "string" }, "itqStatusUpdatedDate": { "type": "string", "format": "date-time" }, "itqTransactionType": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ERPEmployeeSalesBudgetLineDto": { "required": [ "lnlEmployeeID", "lnlSalesBudgetPeriodID", "lnlSalesBudgetYearID" ], "type": "object", "properties": { "lnlBudgetAmount": { "minimum": 0, "type": "number", "format": "double" }, "lnlEmployeeID": { "type": "string" }, "lnlEndDate": { "type": "string", "format": "date-time" }, "lnlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lnlRowVersion": { "type": "integer", "format": "int64" }, "lnlSalesBudgetPeriodID": { "type": "integer", "format": "int32" }, "lnlSalesBudgetYearID": { "type": "integer", "format": "int32" }, "lnlStartDate": { "type": "string", "format": "date-time" } } }, "ERPEmployeeSalesBudgetDto": { "required": [ "lnsEmployeeID", "lnsSalesBudgetYearID" ], "type": "object", "properties": { "lnsAnnualAmount": { "minimum": 0, "type": "number", "format": "double" }, "lnsEmployeeID": { "type": "string" }, "lnsEndDate": { "type": "string", "format": "date-time" }, "lnsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lnsRowVersion": { "type": "integer", "format": "int64" }, "lnsSalesBudgetYearID": { "type": "integer", "format": "int32" }, "lnsStartDate": { "type": "string", "format": "date-time" } } }, "ERPEmployeeSkillCompetencyDto": { "required": [ "lnpCompetencyID", "lnpEmployeeID", "lnpEmployeeSkillID", "lnpEmployeeSkillCompetencyID", "lnpSkillID" ], "type": "object", "properties": { "lnpCommentsRTF": { "type": "string" }, "lnpCommentsText": { "type": "string" }, "lnpCompetencyID": { "type": "string" }, "lnpCreatedBy": { "type": "string" }, "lnpCreatedDate": { "type": "string", "format": "date-time" }, "lnpDateAchieved": { "type": "string", "format": "date-time" }, "lnpDateExpires": { "type": "string", "format": "date-time" }, "lnpEmployeeID": { "type": "string" }, "lnpEmployeeSkillID": { "type": "integer", "format": "int32" }, "lnpUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lnpRowVersion": { "type": "integer", "format": "int64" }, "lnpEmployeeSkillCompetencyID": { "type": "integer", "format": "int32" }, "lnpSkillID": { "type": "string" } } }, "ERPEmployeeSkillDto": { "required": [ "lnkEmployeeID", "lnkEmployeeSkillID", "lnkSkillID" ], "type": "object", "properties": { "lnkCreatedBy": { "type": "string" }, "lnkCreatedDate": { "type": "string", "format": "date-time" }, "lnkDocuments": { "type": "string" }, "lnkEmployeeID": { "type": "string" }, "lnkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lnkNotesRTF": { "type": "string" }, "lnkNotesText": { "type": "string" }, "lnkRowVersion": { "type": "integer", "format": "int64" }, "lnkEmployeeSkillID": { "type": "integer", "format": "int32" }, "lnkSkillID": { "type": "string" } } }, "ERPShiftBreakDto": { "required": [ "lmtDay", "lmtShiftID" ], "type": "object", "properties": { "lmtBreak1EndTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtBreak1StartTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtBreak2EndTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtBreak2StartTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtBreak3EndTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtBreak3StartTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtCreatedBy": { "type": "string" }, "lmtCreatedDate": { "type": "string", "format": "date-time" }, "lmtDay": { "type": "integer", "format": "int32" }, "lmtEndTime": { "minimum": 0, "type": "number", "format": "double" }, "lmtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmtBreak1Paid": { "type": "boolean" }, "lmtBreak2Paid": { "type": "boolean" }, "lmtBreak3Paid": { "type": "boolean" }, "lmtRowVersion": { "type": "integer", "format": "int64" }, "lmtShiftID": { "type": "integer", "format": "int32" }, "lmtStartTime": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPShiftDto": { "required": [ "lmsShiftID", "lmsShiftGroup" ], "type": "object", "properties": { "lmsAutoClockOutLastRunTime": { "type": "string", "format": "date-time" }, "lmsAutoClockOutTime": { "minimum": 0, "type": "number", "format": "double" }, "lmsClockInWindow": { "type": "integer", "format": "int32" }, "lmsClockOutWindow": { "type": "integer", "format": "int32" }, "lmsCreatedBy": { "type": "string" }, "lmsCreatedDate": { "type": "string", "format": "date-time" }, "lmsDescription": { "type": "string" }, "lmsUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lmsGraceTimeIn": { "type": "integer", "format": "int32" }, "lmsGraceTimeOut": { "type": "integer", "format": "int32" }, "lmsIdleTimeIndirectLaborID": { "type": "string" }, "lmsIdleTimeWorkCenterID": { "type": "string" }, "lmsInactiveDate": { "type": "string", "format": "date-time" }, "lmsInactive": { "type": "boolean" }, "lmsRoundClockWithInShift": { "type": "boolean" }, "lmsRoundJobsOutsideOfShift": { "type": "boolean" }, "lmsRoundJobsWithinShift": { "type": "boolean" }, "lmsRoundOutsideOfShift": { "type": "boolean" }, "lmsPlantID": { "type": "string" }, "lmsRoundClockInDirection": { "type": "string" }, "lmsRoundClockOutDirection": { "type": "string" }, "lmsRoundTo": { "type": "integer", "format": "int32" }, "lmsRowVersion": { "type": "integer", "format": "int64" }, "lmsShiftID": { "type": "integer", "format": "int32" }, "lmsShiftGroup": { "type": "integer", "format": "int32" } } }, "ERPSkillCompetencyDto": { "required": [ "lecCompetencyID", "lecDescription" ], "type": "object", "properties": { "lecColor": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "lecCompetencyID": { "type": "string" }, "lecCreatedBy": { "type": "string" }, "lecCreatedDate": { "type": "string", "format": "date-time" }, "lecDescription": { "type": "string" }, "lecUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lecInactiveDate": { "type": "string", "format": "date-time" }, "lecInactive": { "type": "boolean" }, "lecLevel": { "type": "integer", "format": "int32" }, "lecLongDescriptionRtf": { "type": "string" }, "lecLongDescriptionText": { "type": "string" }, "lecRowVersion": { "type": "integer", "format": "int64" } } }, "ERPSkillDto": { "required": [ "lesSkillID", "lesDescription" ], "type": "object", "properties": { "lesSkillID": { "type": "string" }, "lesCreatedBy": { "type": "string" }, "lesCreatedDate": { "type": "string", "format": "date-time" }, "lesDescription": { "type": "string" }, "lesUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "lesInactiveDate": { "type": "string", "format": "date-time" }, "lesInactive": { "type": "boolean" }, "lesLongDescriptionRtf": { "type": "string" }, "lesLongDescriptionText": { "type": "string" }, "lesRowVersion": { "type": "integer", "format": "int64" } } }, "ERPWorkCenterSkillCompetencyDto": { "required": [ "xbbCompetencyID", "xbbWorkCenterSkillCompetencyID", "xbbSkillID", "xbbWorkCenterID", "xbbWorkCenterSkillID" ], "type": "object", "properties": { "xbbCommentsRTF": { "type": "string" }, "xbbCommentsText": { "type": "string" }, "xbbCompetencyID": { "type": "string" }, "xbbCreatedBy": { "type": "string" }, "xbbCreatedDate": { "type": "string", "format": "date-time" }, "xbbDateAchieved": { "type": "string", "format": "date-time" }, "xbbDateExpires": { "type": "string", "format": "date-time" }, "xbbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xbbRowVersion": { "type": "integer", "format": "int64" }, "xbbWorkCenterSkillCompetencyID": { "type": "integer", "format": "int32" }, "xbbSkillID": { "type": "string" }, "xbbWorkCenterID": { "type": "string" }, "xbbWorkCenterSkillID": { "type": "integer", "format": "int32" } } }, "ERPWorkCenterSkillDto": { "required": [ "xbaWorkCenterSkillID", "xbaSkillID", "xbaWorkCenterID" ], "type": "object", "properties": { "xbaCreatedBy": { "type": "string" }, "xbaCreatedDate": { "type": "string", "format": "date-time" }, "xbaDocuments": { "type": "string" }, "xbaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xbaNotesRTF": { "type": "string" }, "xbaNotesText": { "type": "string" }, "xbaRowVersion": { "type": "integer", "format": "int64" }, "xbaWorkCenterSkillID": { "type": "integer", "format": "int32" }, "xbaSkillID": { "type": "string" }, "xbaWorkCenterID": { "type": "string" } } }, "ERPAgingBucketDto": { "required": [ "xaaBucket1Description", "xaaCalculationType", "xaaAgingBucketID", "xaaDescription" ], "type": "object", "properties": { "xaaBucket1DaysOver": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "xaaBucket1Description": { "type": "string" }, "xaaBucket2DaysOver": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "xaaBucket2Description": { "type": "string" }, "xaaBucket3DaysOver": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "xaaBucket3Description": { "type": "string" }, "xaaBucket4DaysOver": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "xaaBucket4Description": { "type": "string" }, "xaaBucket5DaysOver": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "xaaBucket5Description": { "type": "string" }, "xaaCalculationType": { "type": "integer", "format": "int32" }, "xaaAgingBucketID": { "type": "string" }, "xaaCreatedBy": { "type": "string" }, "xaaCreatedDate": { "type": "string", "format": "date-time" }, "xaaDescription": { "type": "string" }, "xaaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xaaRowVersion": { "type": "integer", "format": "int64" } } }, "ERPAssetTypeMethodDto": { "required": [ "famAssetTypeID", "famBookDepreciationMethod", "famBookMultiplier", "famCalculationMethod", "famAssetTypeMethodID", "famStartDate" ], "type": "object", "properties": { "famAssetTypeID": { "type": "string" }, "famBookDepreciationMethod": { "type": "string" }, "famBookMultiplier": { "minimum": 0, "type": "number", "format": "double" }, "famCalculationMethod": { "type": "string" }, "famCreatedBy": { "type": "string" }, "famCreatedDate": { "type": "string", "format": "date-time" }, "famUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "famCurrentMethod": { "type": "boolean" }, "famMonthCalculationType": { "type": "string" }, "famRowVersion": { "type": "integer", "format": "int64" }, "famAssetTypeMethodID": { "type": "integer", "format": "int32" }, "famStartDate": { "type": "string", "format": "date-time" }, "famTaxDepreciationMethod": { "type": "string" }, "famTaxMultiplier": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPAssetTypePlantDto": { "required": [ "fayAccumDeprGlAccountID", "fayAssetGlAccountID", "fayAssetTypeID", "fayAssetTypePlantID", "fayDepreciationGlAccountID", "fayExpenseGlAccountID", "fayLossGlAccountID", "fayProfitGlAccountID", "fayRepairsGlAccountID", "fayRevaluationGlAccountID" ], "type": "object", "properties": { "fayAccumDeprGlAccountID": { "type": "string" }, "fayAssetGlAccountID": { "type": "string" }, "fayAssetTypeID": { "type": "string" }, "fayAssetTypePlantID": { "type": "string" }, "fayCreatedBy": { "type": "string" }, "fayCreatedDate": { "type": "string", "format": "date-time" }, "fayDepreciationGlAccountID": { "type": "string" }, "fayUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fayExpenseGlAccountID": { "type": "string" }, "fayLossGlAccountID": { "type": "string" }, "fayProfitGlAccountID": { "type": "string" }, "fayRepairsGlAccountID": { "type": "string" }, "fayRevaluationGlAccountID": { "type": "string" }, "fayRowVersion": { "type": "integer", "format": "int64" } } }, "ERPAssetTypeDto": { "required": [ "fatAccumDeprGlAccountID", "fatAssetGlAccountID", "fatAssetTypeID", "fatDepreciationGlAccountID", "fatDescription", "fatExpenseGlAccountID", "fatLossGlAccountID", "fatProfitGlAccountID", "fatRepairsGlAccountID", "fatRevaluationGlAccountID" ], "type": "object", "properties": { "fatAccumDeprGlAccountID": { "type": "string" }, "fatAssetGlAccountID": { "type": "string" }, "fatAssetTypeID": { "type": "string" }, "fatCreatedBy": { "type": "string" }, "fatCreatedDate": { "type": "string", "format": "date-time" }, "fatDepreciationGlAccountID": { "type": "string" }, "fatDescription": { "type": "string" }, "fatUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "fatExpenseGlAccountID": { "type": "string" }, "fatLossGlAccountID": { "type": "string" }, "fatProfitGlAccountID": { "type": "string" }, "fatRepairsGlAccountID": { "type": "string" }, "fatRevaluationGlAccountID": { "type": "string" }, "fatRowVersion": { "type": "integer", "format": "int64" } } }, "ERPGLFiscalYearOpeningBalanceDto": { "type": "object", "properties": { "glyCreatedBy": { "type": "string" }, "glyCreatedDate": { "type": "string", "format": "date-time" }, "glyUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "glyGlAccountID": { "type": "string" }, "glyGlFiscalYearID": { "type": "integer", "format": "int32" }, "glyRowVersion": { "type": "integer", "format": "int64" }, "glyYearOpeningBalance": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPGLFiscalYearPeriodMovementDto": { "type": "object", "properties": { "gliCreatedBy": { "type": "string" }, "gliCreatedDate": { "type": "string", "format": "date-time" }, "gliUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "gliGlAccountID": { "type": "string" }, "gliGlFiscalYearID": { "type": "integer", "format": "int32" }, "gliGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "gliRowVersion": { "type": "integer", "format": "int64" }, "gliTotalCredits": { "minimum": 0, "type": "number", "format": "double" }, "gliTotalDebits": { "minimum": 0, "type": "number", "format": "double" } } }, "ERPChangeLogDto": { "required": [ "xagChangeDate", "xagChangeType", "xagChangeUserID", "xagChangeLogID", "xagTableName" ], "type": "object", "properties": { "xagChangeDate": { "type": "string", "format": "date-time" }, "xagChangeType": { "type": "string" }, "xagChangeUserID": { "type": "string" }, "xagRowVersion": { "type": "integer", "format": "int64" }, "xagChangeLogID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "xagTableKeyValues": { "type": "string" }, "xagTableName": { "type": "string" }, "xagTableNewValues": { "type": "string" }, "xagTableOldValues": { "type": "string" }, "xagTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" } } }, "ERPDatasetPropertyDto": { "required": [ "xadDescription", "xadName", "xadVersion" ], "type": "object", "properties": { "xadAddressLine1": { "type": "string" }, "xadAddressLine2": { "type": "string" }, "xadAddressLine3": { "type": "string" }, "xadBankAccountID": { "type": "string" }, "xadBuyQuantityDecimals": { "type": "integer", "format": "int32" }, "xadCArPPRegistrationNumber": { "type": "string" }, "xadCASubmissionReference": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "xadCATransmitterNumber": { "type": "string" }, "xadCity": { "type": "string" }, "xadColor": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "xadCompanyMessageRTF": { "type": "string" }, "xadCompanyMessageText": { "type": "string" }, "xadCountry": { "type": "string" }, "xadCountryCode": { "type": "string" }, "xadCreatedBy": { "type": "string" }, "xadCreatedDate": { "type": "string", "format": "date-time" }, "xadCreditCardBankAccountID": { "type": "string" }, "xadCurrencyRateID": { "type": "string" }, "xadDayStartTimeFri": { "minimum": 0, "type": "number", "format": "double" }, "xadDayStartTimeMon": { "minimum": 0, "type": "number", "format": "double" }, "xadDayStartTimeSat": { "minimum": 0, "type": "number", "format": "double" }, "xadDayStartTimeSun": { "minimum": 0, "type": "number", "format": "double" }, "xadDayStartTimeThu": { "minimum": 0, "type": "number", "format": "double" }, "xadDayStartTimeTue": { "minimum": 0, "type": "number", "format": "double" }, "xadDayStartTimeWed": { "minimum": 0, "type": "number", "format": "double" }, "xadDescription": { "type": "string" }, "xadEmailAddress": { "type": "string" }, "xadUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xadExtensionVersions": { "type": "string" }, "xadFaxNumber": { "type": "string" }, "xadFederalID": { "type": "string" }, "xadForeColor": { "maximum": 99999999, "minimum": 0, "type": "integer", "format": "int32" }, "xadGlChartPrefix": { "type": "string" }, "xadGlDepartmentID": { "type": "string" }, "xadGlDivisionID": { "type": "string" }, "xadHoursFri": { "minimum": 0, "type": "number", "format": "double" }, "xadHoursMon": { "minimum": 0, "type": "number", "format": "double" }, "xadHoursSat": { "minimum": 0, "type": "number", "format": "double" }, "xadHoursSun": { "minimum": 0, "type": "number", "format": "double" }, "xadHoursThu": { "minimum": 0, "type": "number", "format": "double" }, "xadHoursTue": { "minimum": 0, "type": "number", "format": "double" }, "xadHoursWed": { "minimum": 0, "type": "number", "format": "double" }, "xadIntraCompanyOrganizationID": { "type": "string" }, "xadInventoryQuantityDecimals": { "type": "integer", "format": "int32" }, "xadAllowIntraCompanyTrans": { "type": "boolean" }, "xadBackupCheck": { "type": "boolean" }, "xadDisableLotNumbers": { "type": "boolean" }, "xadDisableOrganizationParts": { "type": "boolean" }, "xadDisableRetention": { "type": "boolean" }, "xadDisableRevisions": { "type": "boolean" }, "xadDisableSerialNumbers": { "type": "boolean" }, "xadDisableWarehouses": { "type": "boolean" }, "xadEditInExplorers": { "type": "boolean" }, "xadEnableM1Email": { "type": "boolean" }, "xadEnableM1Home": { "type": "boolean" }, "xadEnableMultiCurrency": { "type": "boolean" }, "xadEnableNonNettable": { "type": "boolean" }, "xadEnableOutlookDesktop": { "type": "boolean" }, "xadEnableOutlookOnline": { "type": "boolean" }, "xadExportFollowups": { "type": "boolean" }, "xadExtendedSearchOptions": { "type": "boolean" }, "xadIgnoreSSLCertValidate": { "type": "boolean" }, "xadSuppressAddressOnReports": { "type": "boolean" }, "xadUpdateMasterDataInFinPkg": { "type": "boolean" }, "xadUsingAps": { "type": "boolean" }, "xadViewForeign": { "type": "boolean" }, "xadLanguage": { "type": "string" }, "xadMailProvider": { "type": "string" }, "xadMailServer": { "type": "string" }, "xadMaxGridRow": { "maximum": 9999999, "minimum": 0, "type": "integer", "format": "int32" }, "xadMaxItemsOnGantt": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "xadName": { "type": "string" }, "xadPhoneNumber": { "type": "string" }, "xadPostCode": { "type": "string" }, "xadRegion": { "type": "string" }, "xadRowVersion": { "type": "integer", "format": "int64" }, "xadSellQuantityDecimals": { "type": "integer", "format": "int32" }, "xadState": { "type": "string" }, "xadTimeFormat": { "type": "integer", "format": "int32" }, "xadTimeZone": { "type": "string" }, "xadTINType": { "type": "string" }, "xadUpgradeVersions": { "type": "string" }, "xadUpsInterfaceFolderName": { "type": "string" }, "xadVersion": { "type": "string" }, "xadVersion92UpgradeDate": { "type": "string", "format": "date-time" }, "xadWebAddress": { "type": "string" } } }, "ERPFinancialPropertyDto": { "required": [ "xafAgingMethod", "xafArFinanceShowCreditBalance", "xafTaxOnReportMethod" ], "type": "object", "properties": { "xafAccruedCreditorsGlAccountID": { "type": "string" }, "xafAgingMethod": { "type": "integer", "format": "int32" }, "xafApAgingBucketID": { "type": "string" }, "xafApApCostStartDate": { "type": "string", "format": "date-time" }, "xafApApGlAccountID": { "type": "string" }, "xafApCashGlAccountID": { "type": "string" }, "xafApDiscountGlAccountID": { "type": "string" }, "xafApFreightGlAccountID": { "type": "string" }, "xafApGroupReceiptsBySupplier": { "type": "integer", "format": "int32" }, "xafApPaymentMaxLinesPerPage": { "type": "integer", "format": "int32" }, "xafArAgingBucketID": { "type": "string" }, "xafArArGlAccountID": { "type": "string" }, "xafArCashGlAccountID": { "type": "string" }, "xafArDefaultLaborPartGroupID": { "type": "string" }, "xafArDepositGlAccountID": { "type": "string" }, "xafArDepositPartID": { "type": "string" }, "xafArDepositPartRevisionID": { "type": "string" }, "xafArDiscountGlAccountID": { "type": "string" }, "xafArFinanceChargeGlAccountID": { "type": "string" }, "xafArFinanceChargeGraceDays": { "type": "integer", "format": "int32" }, "xafArFinanceChargeLastRunDate": { "type": "string", "format": "date-time" }, "xafArFinanceChargePercent": { "minimum": 0, "type": "number", "format": "double" }, "xafArFinanceShowCreditBalance": { "type": "integer", "format": "int32" }, "xafArFreightGlAccountID": { "type": "string" }, "xafArGroupShipmentsByCustomer": { "type": "integer", "format": "int32" }, "xafArLaborPartID": { "type": "string" }, "xafArLaborPartRevisionID": { "type": "string" }, "xafArNET1GatewayID": { "type": "string" }, "xafArNET1MerchantKey": { "type": "string" }, "xafArNET1Port": { "maximum": 999999, "minimum": 0, "type": "integer", "format": "int32" }, "xafArNET1TimeoutSeconds": { "type": "integer", "format": "int32" }, "xafArShowDeposits": { "type": "integer", "format": "int32" }, "xafAvalaraAccountID": { "type": "string" }, "xafAvalaraArInvoicePostOption": { "type": "integer", "format": "int32" }, "xafAvalaraCanadaGstTaxCodeID": { "type": "string" }, "xafAvalaraCanadaHSTTaxCodeID": { "type": "string" }, "xafAvalaraCanadaPSTTaxCodeID": { "type": "string" }, "xafAvalaraCanadaQSTTaxCodeID": { "type": "string" }, "xafAvalaraCompanyCode": { "type": "string" }, "xafAvalaraFilterCountry": { "type": "integer", "format": "int32" }, "xafAvalaraLicenseKey": { "type": "string" }, "xafAvalaraTaxCodeID": { "type": "string" }, "xafAvalaraTimeoutSeconds": { "type": "integer", "format": "int32" }, "xafAvalaraURL": { "type": "string" }, "xafCAEmployerDentalBenefits": { "type": "integer", "format": "int32" }, "xafCogsStatusHistory": { "type": "string" }, "xafCogsUseAccounts": { "type": "integer", "format": "int32" }, "xafCreatedBy": { "type": "string" }, "xafCreatedDate": { "type": "string", "format": "date-time" }, "xafCreditCardMethod": { "type": "integer", "format": "int32" }, "xafDrawerCashGlAccountID": { "type": "string" }, "xafDrawerCashStartAmount": { "minimum": 0, "type": "number", "format": "double" }, "xafUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xafGlFiscalYearID": { "type": "integer", "format": "int32" }, "xafGlFiscalYearPeriodID": { "type": "integer", "format": "int32" }, "xafGlRetainedEarningsAccountID": { "type": "string" }, "xafAgeByDaysInMonth": { "type": "boolean" }, "xafApAllowParentAccountPost": { "type": "boolean" }, "xafApAlwaysTakeDiscount": { "type": "boolean" }, "xafApAssignNumbersToEft": { "type": "boolean" }, "xafApCreditUpdatesReceipt": { "type": "boolean" }, "xafApDisableTaxFields": { "type": "boolean" }, "xafApDiscountOnFreight": { "type": "boolean" }, "xafApDiscountOnTax": { "type": "boolean" }, "xafApExpressPost": { "type": "boolean" }, "xafApIncludeTaxInExpAmt": { "type": "boolean" }, "xafApPaymentFilterPlant": { "type": "boolean" }, "xafApTaxOnFreight": { "type": "boolean" }, "xafApUpdateJobCosts": { "type": "boolean" }, "xafArAllowParentAccountPost": { "type": "boolean" }, "xafArCalculateTaxOnDeposit": { "type": "boolean" }, "xafArCreateDiscountJournals": { "type": "boolean" }, "xafArCreditUpdatesShipment": { "type": "boolean" }, "xafArDisableTaxFields": { "type": "boolean" }, "xafArDiscountOnFreight": { "type": "boolean" }, "xafArExpressPost": { "type": "boolean" }, "xafArIncludeFrgtInDepositCalc": { "type": "boolean" }, "xafArIncludeTaxInDepositCalc": { "type": "boolean" }, "xafArPaymentFilterPlant": { "type": "boolean" }, "xafArTaxOnFreight": { "type": "boolean" }, "xafAvalaraDisableAddrValidate": { "type": "boolean" }, "xafAvalaraDisableIgnoreLine": { "type": "boolean" }, "xafAvalaraForceAddressValidate": { "type": "boolean" }, "xafCreateBankEntries": { "type": "boolean" }, "xafDisableMultiplePlants": { "type": "boolean" }, "xafExactDaysInPaymentTerms": { "type": "boolean" }, "xafFAroundToNearestDollar": { "type": "boolean" }, "xafGlCreateStockJournals": { "type": "boolean" }, "xafGlExpressPost": { "type": "boolean" }, "xafIncludeLLInTermination": { "type": "boolean" }, "xafPAAllowParentAccountPost": { "type": "boolean" }, "xafPAAssignNumbersToEft": { "type": "boolean" }, "xafPADeleteZeroPayHeaders": { "type": "boolean" }, "xafPAExpressPost": { "type": "boolean" }, "xafPartsMustExist": { "type": "boolean" }, "xafPAShowHolidaysForSalary": { "type": "boolean" }, "xafProductionExpressPost": { "type": "boolean" }, "xafRecalcSalarySacrifice": { "type": "boolean" }, "xafStpSetGrossPayAsETP": { "type": "boolean" }, "xafLaborClearingGlAccountID": { "type": "string" }, "xafMiscReceiptVarianceAccount": { "type": "integer", "format": "int32" }, "xafOverheadClearingGlAccountID": { "type": "string" }, "xafPALeaveBalanceCheck": { "type": "integer", "format": "int32" }, "xafPAUseDate": { "type": "integer", "format": "int32" }, "xafPurchaseVarianceGlAccountID": { "type": "string" }, "xafRoundingGlAccountID": { "type": "string" }, "xafRowVersion": { "type": "integer", "format": "int64" }, "xafShipAwaitInvoiceGlAccountID": { "type": "string" }, "xafStockInTransitGlAccountID": { "type": "string" }, "xafStockRevaluationGlAccountID": { "type": "string" }, "xafStoreCreditGlAccountID": { "type": "string" }, "xafSuperEmployerID": { "type": "string" }, "xafSuperEndDate": { "type": "string", "format": "date-time" }, "xafSuperExportDateFormat": { "type": "string" }, "xafSuperExportFilePath": { "type": "string" }, "xafSuperStartDate": { "type": "string", "format": "date-time" }, "xafSVarLaborGlAccountID": { "type": "string" }, "xafSVarMaterialGlAccountID": { "type": "string" }, "xafSVarOverheadGlAccountID": { "type": "string" }, "xafSVarSubcontractGlAccountID": { "type": "string" }, "xafTaxOnReportMethod": { "type": "string" }, "xafTestFileCode": { "type": "string" }, "xafTransmitterControlCode": { "type": "string" }, "xafUS1094FileLocation": { "type": "string" }, "xafWipLaborGlAccountID": { "type": "string" }, "xafWipMaterialGlAccountID": { "type": "string" }, "xafWipoverheadGlAccountID": { "type": "string" }, "xafWipSubcontractGlAccountID": { "type": "string" } } }, "ERPProductionPropertyDto": { "required": [ "xapCmSalesPersonDefaultLoc", "xapDcLaborCalculationMethod", "xapDcPayCalculationMethod", "xapDcTimeFormat", "xapImCostingMethod", "xapImMfgDefaultCostType", "xapJmJobMaterialSource", "xapJmLoadReliefMethod", "xapJmStandardFactor", "xapPmCostingMethod", "xapPmDefaultDueDate", "xapPmPoWizardDisplayType", "xapPmPurchaseType", "xapPRLaborMethod", "xapQmFollowUpType", "xapQmQuoteMarkupType", "xapQmQuotingMethod" ], "type": "object", "properties": { "xapAllowNegQtyOnHandHistory": { "type": "string" }, "xapAnonymousCustomerID": { "type": "string" }, "xapChChangeRequestTypeID": { "type": "string" }, "xapCmArPaymentCreditMessage": { "type": "integer", "format": "int32" }, "xapCmArPaymentHoldMessage": { "type": "integer", "format": "int32" }, "xapCmFieldServiceCreditMessage": { "type": "integer", "format": "int32" }, "xapCmFieldServiceHoldMessage": { "type": "integer", "format": "int32" }, "xapCmNonTaxReasonID": { "type": "string" }, "xapCmOrderCreditMessage": { "type": "integer", "format": "int32" }, "xapCmOrderHoldMessage": { "type": "integer", "format": "int32" }, "xapCmSalesPersonDefaultLoc": { "type": "integer", "format": "int32" }, "xapCmShipmentCreditMessage": { "type": "integer", "format": "int32" }, "xapCmShipmentHoldMessage": { "type": "integer", "format": "int32" }, "xapCostingMethodHistory": { "type": "string" }, "xapCreatedBy": { "type": "string" }, "xapCreatedDate": { "type": "string", "format": "date-time" }, "xapDateToSchedule": { "type": "string", "format": "date-time" }, "xapDcAutoClockOutComputer": { "type": "string" }, "xapDcIdleTimeThreshhold": { "type": "integer", "format": "int32" }, "xapDcLaborCalculationMethod": { "type": "integer", "format": "int32" }, "xapDcPayCalculationMethod": { "type": "integer", "format": "int32" }, "xapDcRefreshInterval": { "type": "integer", "format": "int32" }, "xapDcSfeInspectionPassword": { "type": "string" }, "xapDcSfeShutdownPassword": { "type": "string" }, "xapDcTimeFormat": { "type": "integer", "format": "int32" }, "xapDMDefaultFolder": { "type": "string" }, "xapEdi810ServiceUrl": { "type": "string" }, "xapEdi856ServiceUrl": { "type": "string" }, "xapEdiPassword": { "type": "string" }, "xapEdiUserName": { "type": "string" }, "xapUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xapHdAttachmentFilePath": { "type": "string" }, "xapHdcallDueDateDays": { "type": "integer", "format": "int32" }, "xapHdcallTypeID": { "type": "string" }, "xapHdcontactMethodID": { "type": "string" }, "xapHdMailMergeCallTypeID": { "type": "string" }, "xapHdMailMergeContactMethodID": { "type": "string" }, "xapHdNewCallSoundFile": { "type": "string" }, "xapHdSalesCallTypeID": { "type": "string" }, "xapImAutoCreateRevisionID": { "type": "string" }, "xapImCostingMethod": { "type": "integer", "format": "int32" }, "xapImMfgDefaultCostType": { "type": "integer", "format": "int32" }, "xapCmCreateJobOnly": { "type": "boolean" }, "xapCmCreditLimitSourceInv": { "type": "boolean" }, "xapCmCreditLimitSourceOrder": { "type": "boolean" }, "xapCmCreditLimitSourceShip": { "type": "boolean" }, "xapCmCustomerTaxable": { "type": "boolean" }, "xapCmEnableResellers": { "type": "boolean" }, "xapCmIncludeFreightInPrice": { "type": "boolean" }, "xapDcAllowNegativeQty": { "type": "boolean" }, "xapDcAllowProductionComplete": { "type": "boolean" }, "xapDcAutoClockOutLocked": { "type": "boolean" }, "xapDcEnableCreateSequence": { "type": "boolean" }, "xapDcEnableIssueMaterial": { "type": "boolean" }, "xapDcEnableJobTraveler": { "type": "boolean" }, "xapDcEnableMinimizeButtonInSfe": { "type": "boolean" }, "xapDcEnableTimecardAudit": { "type": "boolean" }, "xapDcEnableWorkQueue": { "type": "boolean" }, "xapDcPromptForActivityPassword": { "type": "boolean" }, "xapDcPromptForAuditPassword": { "type": "boolean" }, "xapDcPromptForClockInPassword": { "type": "boolean" }, "xapDcPromptForLaborDescription": { "type": "boolean" }, "xapDcPromptForMessagePassword": { "type": "boolean" }, "xapDcPromptForReason": { "type": "boolean" }, "xapDcShowCurrentJobsOnly": { "type": "boolean" }, "xapDcSplitDirectLaborHours": { "type": "boolean" }, "xapDcSplitIndirectLaborHours": { "type": "boolean" }, "xapDcUseServerTime": { "type": "boolean" }, "xapDcWarnOnOutsideOperation": { "type": "boolean" }, "xapDcWarnOnOverProduction": { "type": "boolean" }, "xapGlCreateStockJournals": { "type": "boolean" }, "xapHdcreateCallForEmails": { "type": "boolean" }, "xapImAllowNegativeQtyOnHand": { "type": "boolean" }, "xapImAutoCreateRevision": { "type": "boolean" }, "xapImCopyAlternates": { "type": "boolean" }, "xapImCopyPartMemos": { "type": "boolean" }, "xapImCopyPartOrgReferences": { "type": "boolean" }, "xapImCopyPartPrices": { "type": "boolean" }, "xapImCopyPartRules": { "type": "boolean" }, "xapImEnableOrgPartCustomer": { "type": "boolean" }, "xapImEnableOrgPartSupplier": { "type": "boolean" }, "xapImEnableWarningWhenNegative": { "type": "boolean" }, "xapImForceConfiguratorScreens": { "type": "boolean" }, "xapImHideUseMethodInTree": { "type": "boolean" }, "xapImIgnoreLCInStdCostRollup": { "type": "boolean" }, "xapImOnlyAllowExistingBins": { "type": "boolean" }, "xapImOverwriteDescription": { "type": "boolean" }, "xapImOverwriteDocuments": { "type": "boolean" }, "xapImOverwriteMethod": { "type": "boolean" }, "xapImRefreshMaterial": { "type": "boolean" }, "xapImRefreshMaterialCosts": { "type": "boolean" }, "xapImScrapRoundUp": { "type": "boolean" }, "xapImSetUseMethod": { "type": "boolean" }, "xapImTransferCustomer": { "type": "boolean" }, "xapImTransferDescriptions": { "type": "boolean" }, "xapImTransferMaterial": { "type": "boolean" }, "xapImUseStdForStdCostRollUp": { "type": "boolean" }, "xapJmExcessQuantity": { "type": "boolean" }, "xapJmIgnoreEmployees": { "type": "boolean" }, "xapJmIgnoreMachines": { "type": "boolean" }, "xapJmLoadLevelFinite": { "type": "boolean" }, "xapJmMinimizeGaps": { "type": "boolean" }, "xapJmMRPForecastFirmJob": { "type": "boolean" }, "xapJmOverwriteDescription": { "type": "boolean" }, "xapJmOverwriteDocuments": { "type": "boolean" }, "xapJmOverwriteMethod": { "type": "boolean" }, "xapJmRefreshHours": { "type": "boolean" }, "xapJmRefreshMaterial": { "type": "boolean" }, "xapJmRefreshMaterialCosts": { "type": "boolean" }, "xapJmScheduleShowActualTimes": { "type": "boolean" }, "xapJmScheduleUseActuals": { "type": "boolean" }, "xapJmShopLoadShowFutureLoad": { "type": "boolean" }, "xapJmShopLoadShowPastLoad": { "type": "boolean" }, "xapLmUpdateActualWithRounded": { "type": "boolean" }, "xapNextSerialNumberPerGroup": { "type": "boolean" }, "xapOmAutoCreateDelivery": { "type": "boolean" }, "xapOmEnableDiscountFields": { "type": "boolean" }, "xapOmEnableFreightFields": { "type": "boolean" }, "xapOmIncludeOrderDeliveryInJob": { "type": "boolean" }, "xapOmIncludeOrderLineInJob": { "type": "boolean" }, "xapOmMarkCreateJobForMto": { "type": "boolean" }, "xapOmMarkPullQuoteMethodForMto": { "type": "boolean" }, "xapOmShowDeliveriesInTree": { "type": "boolean" }, "xapOmUseQuotingMarkupTM": { "type": "boolean" }, "xapPmPTOUsesDeliveryCost": { "type": "boolean" }, "xapPmPurPlannerIncWhsQties": { "type": "boolean" }, "xapPmPurPlannerUseBestPrice": { "type": "boolean" }, "xapPmShowFirmOnlyPoWiz": { "type": "boolean" }, "xapPoWizardShowQtyToInspect": { "type": "boolean" }, "xapPRUseFirmQuotesOnly": { "type": "boolean" }, "xapQArmaRequiresInspection": { "type": "boolean" }, "xapQAShowRmaOtherInfo": { "type": "boolean" }, "xapQmMultipleQuantities": { "type": "boolean" }, "xapQmMUseDefHeaderFooterText": { "type": "boolean" }, "xapQmOverwriteDescription": { "type": "boolean" }, "xapQmOverwriteDocuments": { "type": "boolean" }, "xapQmOverwriteMethod": { "type": "boolean" }, "xapQmRefreshMaterial": { "type": "boolean" }, "xapQmRefreshMaterialCosts": { "type": "boolean" }, "xapQmRefreshRateInfo": { "type": "boolean" }, "xapRQGroupPobyRfq": { "type": "boolean" }, "xapRQIncludeAlternateParts": { "type": "boolean" }, "xapSfeAllowSuspend": { "type": "boolean" }, "xapSfeBarcodeScanner": { "type": "boolean" }, "xapSfeTouchScreen": { "type": "boolean" }, "xapSmDeleteZeroShipmentLines": { "type": "boolean" }, "xapSmShowWMSFields": { "type": "boolean" }, "xapJmCalendarExportFields": { "type": "string" }, "xapJmInitialExtension": { "type": "string" }, "xapJmInsideInspectionLineRTF": { "type": "string" }, "xapJmInsideInspectionLineText": { "type": "string" }, "xapJmJobMaterialSource": { "type": "integer", "format": "int32" }, "xapJmLoadReliefMethod": { "type": "integer", "format": "int32" }, "xapJmOutsideInspectionLineRTF": { "type": "string" }, "xapJmOutsideInspectionLineText": { "type": "string" }, "xapJmScheduleBoardFields": { "type": "string" }, "xapJmScheduleType": { "type": "integer", "format": "int32" }, "xapJmShopLoadBuckets": { "type": "integer", "format": "int32" }, "xapJmShopLoadDays": { "type": "integer", "format": "int32" }, "xapJmShopLoadDepartmentID": { "type": "string" }, "xapJmShopLoadFields": { "type": "string" }, "xapJmShopLoadPlantID": { "type": "string" }, "xapJmShopLoadTimeType": { "type": "string" }, "xapJmSplitCosts": { "type": "integer", "format": "int32" }, "xapJmStandardFactor": { "type": "string" }, "xapLmCalculateEndTime": { "type": "integer", "format": "int32" }, "xapLmLeaveBoardFields": { "type": "string" }, "xapLOResponseMethodID": { "type": "string" }, "xapNextSerialNumberIDFormula": { "type": "string" }, "xapOmAddlChargePartID": { "type": "string" }, "xapOmAddlChargePartRevisionID": { "type": "string" }, "xapOmDeliveryType": { "type": "integer", "format": "int32" }, "xapOmFreeOnBoardDescription": { "type": "string" }, "xapOmLineQuantityValidation": { "type": "integer", "format": "int32" }, "xapOmOrderDeliveryDigits": { "type": "integer", "format": "int32" }, "xapOmOrderLineDigits": { "type": "integer", "format": "int32" }, "xapOmSalesGlAccountID": { "type": "string" }, "xapOmUnitOfMeasure": { "type": "string" }, "xapPACalendarExportFields": { "type": "string" }, "xapPAExportFormat": { "type": "string" }, "xapPAExportLocation": { "type": "string" }, "xapPmCostingMethod": { "type": "integer", "format": "int32" }, "xapPmDefaultDueDate": { "type": "string", "format": "date-time" }, "xapPmFollowUpDays": { "type": "integer", "format": "int32" }, "xapPmPoWizardDisplayType": { "type": "integer", "format": "int32" }, "xapPmPurchaseType": { "type": "integer", "format": "int32" }, "xapPmTaxExemptNumber": { "type": "string" }, "xapPRLaborMethod": { "type": "integer", "format": "int32" }, "xapQAInspQueueRefreshInterval": { "type": "integer", "format": "int32" }, "xapQmAdditionalChargeText": { "type": "string" }, "xapQmExpirationDays": { "type": "integer", "format": "int32" }, "xapQmFollowUpDays": { "type": "integer", "format": "int32" }, "xapQmFollowUpType": { "type": "integer", "format": "int32" }, "xapQmLaborMarkup": { "minimum": 0, "type": "number", "format": "double" }, "xapQmMaterialMarkup": { "minimum": 0, "type": "number", "format": "double" }, "xapQmMQuoteFooterMessageRTF": { "type": "string" }, "xapQmMQuoteFooterMessageText": { "type": "string" }, "xapQmMQuoteHeaderMessageRTF": { "type": "string" }, "xapQmMQuoteHeaderMessageText": { "type": "string" }, "xapQmOverheadMarkup": { "minimum": 0, "type": "number", "format": "double" }, "xapQmPurchaseToOrderMarkup": { "minimum": 0, "type": "number", "format": "double" }, "xapQmQuoteFooterMessageRTF": { "type": "string" }, "xapQmQuoteFooterMessageText": { "type": "string" }, "xapQmQuoteHeaderMessageRTF": { "type": "string" }, "xapQmQuoteHeaderMessageText": { "type": "string" }, "xapQmQuoteMarkupType": { "type": "integer", "format": "int32" }, "xapQmQuotingMarkup": { "minimum": 0, "type": "number", "format": "double" }, "xapQmQuotingMethod": { "type": "integer", "format": "int32" }, "xapQmSubcontractMarkup": { "minimum": 0, "type": "number", "format": "double" }, "xapRowVersion": { "type": "integer", "format": "int64" }, "xapSfeActiveJobQueueFields": { "type": "string" }, "xapSfeAddPartSelect": { "type": "string" }, "xapSfeAsmSearchFields": { "type": "string" }, "xapSfeEndJobCompletionCode": { "maximum": 9, "minimum": 0, "type": "number", "format": "double" }, "xapSfeEndJobGoodQty": { "type": "string" }, "xapSfeEndJobScrapQty": { "type": "string" }, "xapSfeIssueMaterialQty": { "type": "string" }, "xapSfeJobSearchSelect": { "type": "string" }, "xapSfeJobTraveller": { "type": "string" }, "xapSfeOprSearchFields": { "type": "string" }, "xapSfeSetupPercentage": { "type": "string" }, "xapSfeStartJobWorkCode": { "maximum": 9, "minimum": 0, "type": "number", "format": "double" }, "xapSfeTCAuditReport": { "type": "string" }, "xapSfeWorkQueueFields": { "type": "string" }, "xapSfeWorkQueueSort": { "type": "string" }, "xapShowQtyOnHandMobInv": { "type": "boolean" }, "xapSmEdi856CustomLabel": { "type": "string" }, "xapSmLineQuantityValidation": { "type": "integer", "format": "int32" } } }, "ERPReasonPlantDto": { "required": [ "xajReasonPlantID", "xajReasonID" ], "type": "object", "properties": { "xajReasonPlantID": { "type": "string" }, "xajCreatedBy": { "type": "string" }, "xajCreatedDate": { "type": "string", "format": "date-time" }, "xajUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xajReasonGlAccountID": { "type": "string" }, "xajReasonID": { "type": "string" }, "xajRowVersion": { "type": "integer", "format": "int64" }, "xajScrapGlAccountID": { "type": "string" } } }, "ERPReasonDto": { "required": [ "xarReasonID", "xarDescription", "xarReasonType" ], "type": "object", "properties": { "xarReasonID": { "type": "string" }, "xarCreatedBy": { "type": "string" }, "xarCreatedDate": { "type": "string", "format": "date-time" }, "xarDescription": { "type": "string" }, "xarUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xarReasonGlAccountID": { "type": "string" }, "xarReasonType": { "type": "string" }, "xarRowVersion": { "type": "integer", "format": "int64" }, "xarScrapGlAccountID": { "type": "string" } } }, "ERPRecentActivitiesLogDto": { "type": "object", "properties": { "rtlCount": { "maximum": 99999, "minimum": 0, "type": "integer", "format": "int32" }, "rtlExplorerType": { "type": "string" }, "rtlLastOpenedDateTime": { "type": "string", "format": "date-time" }, "rtlObjectDataRun": { "type": "string" }, "rtlObjectID": { "type": "string" }, "rtlObjectName": { "type": "string" }, "rtlParentKey": { "type": "string" }, "rtlRecentActivityID": { "type": "integer", "format": "int32" }, "rtlRowVersion": { "type": "integer", "format": "int64" }, "rtlUserID": { "type": "string" } } }, "ERPShippingPropertyDto": { "required": [ "xsmFedExAuthenticationMethod", "xsmUpsAuthenticationMethod" ], "type": "object", "properties": { "xsmCreatedBy": { "type": "string" }, "xsmCreatedDate": { "type": "string", "format": "date-time" }, "xsmUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xsmFdxAccessibility": { "type": "string" }, "xsmFdxAccountNumber": { "type": "string" }, "xsmFdxAccountNumberOAuth": { "type": "string" }, "xsmFdxAddressLine1": { "type": "string" }, "xsmFdxAddressLine2": { "type": "string" }, "xsmFdxAddrValAccuracyIndicator": { "type": "string" }, "xsmFdxCity": { "type": "string" }, "xsmFdxClientID": { "type": "string" }, "xsmFdxClientIDTrack": { "type": "string" }, "xsmFdxClientSecret": { "type": "string" }, "xsmFdxClientSecretTrack": { "type": "string" }, "xsmFdxCodCollectionAmount": { "minimum": 0, "type": "number", "format": "double" }, "xsmFdxCodCollectionType": { "type": "string" }, "xsmFdxCountry": { "type": "string" }, "xsmFdxCurrencyType": { "type": "string" }, "xsmFdxDeclaredValueCurrency": { "type": "string" }, "xsmFdxDepartment": { "type": "string" }, "xsmFdxDimensionsUnitOfMeasure": { "type": "string" }, "xsmFdxDropOffType": { "type": "string" }, "xsmFdxEmailAddress": { "type": "string" }, "xsmFdxFaxNumber": { "type": "string" }, "xsmFdxHandlingCost": { "minimum": 0, "type": "number", "format": "double" }, "xsmFdxHomeDeliveryDate": { "type": "string", "format": "date-time" }, "xsmFdxHomeDeliveryType": { "type": "string" }, "xsmFdxHostAddress": { "type": "string" }, "xsmFdxHostPort": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "xsmFdxHostService": { "type": "string" }, "xsmFdxLabelFormatType": { "type": "string" }, "xsmFdxLabelImageType": { "type": "string" }, "xsmFdxLabelStockType": { "type": "string" }, "xsmFdxLabelStoreLocation": { "type": "string" }, "xsmFdxLabelType": { "type": "string" }, "xsmFdxLblPrintOrientType": { "type": "string" }, "xsmFdxMeterNumber": { "minimum": 0, "type": "number", "format": "double" }, "xsmFdxName": { "type": "string" }, "xsmFdxPackageHeight": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "xsmFdxPackageLength": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "xsmFdxPackageWidth": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32" }, "xsmFdxPackaging": { "type": "string" }, "xsmFdxPackagingCost": { "minimum": 0, "type": "number", "format": "double" }, "xsmFdxPagerNumber": { "type": "string" }, "xsmFdxPayorType": { "type": "string" }, "xsmFdxPersonName": { "type": "string" }, "xsmFdxPhoneNumber": { "type": "string" }, "xsmFdxPostCode": { "type": "string" }, "xsmFdxRateElementBasis": { "type": "string" }, "xsmFdxRateRequestType": { "type": "string" }, "xsmFdxRateTypeBasis": { "type": "string" }, "xsmFdxReturnShipIndicator": { "type": "string" }, "xsmFdxShipCostMarkupPct": { "minimum": 0, "type": "number", "format": "double" }, "xsmFdxShipDocImageType": { "type": "string" }, "xsmFdxSignatureOption": { "type": "string" }, "xsmFdxState": { "type": "string" }, "xsmFdxSubscribedServices": { "type": "string" }, "xsmFdxVHCAmountOrPercentage": { "minimum": 0, "type": "number", "format": "double" }, "xsmFdxVHCLevel": { "type": "string" }, "xsmFdxVHCType": { "type": "string" }, "xsmFdxWeightUnitOfMeasure": { "type": "string" }, "xsmFedExAccessKey": { "type": "string" }, "xsmFedExAccessToken": { "type": "string" }, "xsmFedExAccessTokenTrack": { "type": "string" }, "xsmFedExAuthenticationMethod": { "type": "string" }, "xsmFedExPassword": { "type": "string" }, "xsmFedExTokenExpiresIn": { "type": "string", "format": "date-time" }, "xsmFedExTokenExpiresInTrack": { "type": "string", "format": "date-time" }, "xsmFedExUserName": { "type": "string" }, "xsmFdxBareCostOfDuty": { "type": "boolean" }, "xsmFdxBareTrasportationCost": { "type": "boolean" }, "xsmFdxCod": { "type": "boolean" }, "xsmFdxHoldAtLocation": { "type": "boolean" }, "xsmFdxInsideDelivery": { "type": "boolean" }, "xsmFdxInsidePickup": { "type": "boolean" }, "xsmFdxNonstandardContainer": { "type": "boolean" }, "xsmFdxOneItemPerShipment": { "type": "boolean" }, "xsmFdxResidentialAddress": { "type": "boolean" }, "xsmFdxSaturdayDelivery": { "type": "boolean" }, "xsmFdxSaturdayPickup": { "type": "boolean" }, "xsmFedExIsProduction": { "type": "boolean" }, "xsmUpsIsProduction": { "type": "boolean" }, "xsmRowVersion": { "type": "integer", "format": "int64" }, "xsmUpsAccessKey": { "type": "string" }, "xsmUpsAccessToken": { "type": "string" }, "xsmUpsAccountNo": { "type": "string" }, "xsmUpsAccountNoOAuth": { "type": "string" }, "xsmUpsAuthenticationMethod": { "type": "string" }, "xsmUpsLabelStockSize": { "type": "string" }, "xsmUpsLabelStoreLocation": { "type": "string" }, "xsmUpsLabelType": { "type": "string" }, "xsmUpsLocIDPref": { "type": "string" }, "xsmUpsLocPostCodePref": { "type": "string" }, "xsmUpsPassword": { "type": "string" }, "xsmUpsRefreshToken": { "type": "string" }, "xsmUpsUsername": { "type": "string" }, "xsmUSDcurrencyCode": { "type": "string" } } }, "ERPTopActivitiesLogDto": { "type": "object", "properties": { "rxlCount": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "rxlExplorerType": { "type": "string" }, "rxlGridID": { "type": "string" }, "rxlObjectDataRun": { "type": "string" }, "rxlObjectName": { "type": "string" }, "rxlProcessedDateTime": { "type": "string", "format": "date-time" }, "rxlRowVersion": { "type": "integer", "format": "int64" }, "rxlTopActivityID": { "type": "integer", "format": "int32" }, "rxlUserID": { "type": "string" }, "rxlVisualizerID": { "type": "string" }, "rxlVisualizerType": { "type": "string" } } }, "ERPLandedCostCategoryDto": { "required": [ "rmaCategoryType", "rmaLandedCostCategoryID", "rmaDescription" ], "type": "object", "properties": { "rmaCategoryType": { "type": "integer", "format": "int32" }, "rmaLandedCostCategoryID": { "type": "string" }, "rmaCreatedBy": { "type": "string" }, "rmaCreatedDate": { "type": "string", "format": "date-time" }, "rmaDescription": { "type": "string" }, "rmaUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "rmaExpenseSplitPercentTotal": { "minimum": 0, "type": "number", "format": "double" }, "rmaDefault": { "type": "boolean" }, "rmaLandedCostMethod": { "type": "integer", "format": "int32" }, "rmaRowVersion": { "type": "integer", "format": "int64" }, "rmaSupplierLocationID": { "type": "string" }, "rmaSupplierOrganizationID": { "type": "string" } } }, "ERPPartClassPlantDto": { "required": [ "imfPartClassPlantID", "imfPartClassID" ], "type": "object", "properties": { "imfPartClassPlantID": { "type": "string" }, "imfCreatedBy": { "type": "string" }, "imfCreatedDate": { "type": "string", "format": "date-time" }, "imfUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imfInventoryGlAccountID": { "type": "string" }, "imfInvInInspectionGlAccountID": { "type": "string" }, "imfInvInTransferGlAccountID": { "type": "string" }, "imfInvToReturnGlAccountID": { "type": "string" }, "imfPartClassID": { "type": "string" }, "imfRowVersion": { "type": "integer", "format": "int64" } } }, "ERPPartGroupPlantDto": { "required": [ "imvPartGroupPlantID", "imvPartGroupID" ], "type": "object", "properties": { "imvArDepositGlAccountID": { "type": "string" }, "imvPartGroupPlantID": { "type": "string" }, "imvCogsLaborGlAccountID": { "type": "string" }, "imvCogsMaterialGlAccountID": { "type": "string" }, "imvCogsOverheadGlAccountID": { "type": "string" }, "imvCogsSubcontractGlAccountID": { "type": "string" }, "imvCreatedBy": { "type": "string" }, "imvCreatedDate": { "type": "string", "format": "date-time" }, "imvDiscountGlAccountID": { "type": "string" }, "imvUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "imvPartGroupID": { "type": "string" }, "imvRowVersion": { "type": "integer", "format": "int64" }, "imvSalesGlAccountID": { "type": "string" } } }, "ERPProductCategoryDto": { "required": [ "incProductCategoryID", "incDescription" ], "type": "object", "properties": { "incProductCategoryID": { "type": "string" }, "incCreatedBy": { "type": "string" }, "incCreatedDate": { "type": "string", "format": "date-time" }, "incDescription": { "type": "string" }, "incUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "incImageFilePath": { "type": "string" }, "incInactiveDate": { "type": "string", "format": "date-time" }, "incInactive": { "type": "boolean" }, "INCRowVersion": { "type": "integer", "format": "int64" }, "incStructureCode": { "type": "string" }, "incStructureID": { "type": "string" } } }, "ERPProductCategoryLineDto": { "required": [ "insDescription", "insLevel", "insProductCategoryID", "insProductCategoryLineID" ], "type": "object", "properties": { "insCreatedBy": { "type": "string" }, "insCreatedDate": { "type": "string", "format": "date-time" }, "insDescription": { "type": "string" }, "insUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "insImageFilePath": { "type": "string" }, "insInactiveDate": { "type": "string", "format": "date-time" }, "insInactive": { "type": "boolean" }, "insLevel": { "type": "integer", "format": "int32" }, "insParentLineID": { "type": "integer", "format": "int32" }, "insProductCategoryID": { "type": "string" }, "INSRowVersion": { "type": "integer", "format": "int64" }, "insProductCategoryLineID": { "type": "integer", "format": "int32" }, "insStructureCode": { "type": "string" }, "insStructureID": { "type": "string" } } }, "ERPChangeRequestGroupDto": { "required": [ "chgChangeRequestGroupID" ], "type": "object", "properties": { "chgChangeRequestGroupID": { "type": "string" }, "chgCreatedBy": { "type": "string" }, "chgCreatedDate": { "type": "string", "format": "date-time" }, "chgDescription": { "type": "string" }, "chgUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "chgInactiveDate": { "type": "string", "format": "date-time" }, "chgInactive": { "type": "boolean" }, "chgRowVersion": { "type": "integer", "format": "int64" } } }, "ERPProductionCalendarDayDto": { "type": "object", "properties": { "jmyDayOfWeek": { "type": "integer", "format": "int32" }, "jmyDayStartTime": { "minimum": 0, "type": "number", "format": "double" }, "jmyHours": { "minimum": 0, "type": "number", "format": "double" }, "jmyHoliday": { "type": "boolean" }, "jmyPlantID": { "type": "string" }, "jmyProductionCalendarDay": { "type": "integer", "format": "int32" }, "jmyProductionCalendarMonth": { "type": "integer", "format": "int32" }, "jmyProductionCalendarYearID": { "type": "integer", "format": "int32" }, "jmyRowVersion": { "type": "integer", "format": "int64" }, "jmyWorkCenterID": { "type": "string" } } }, "ERPProductionCalendarDto": { "required": [ "jmlProductionCalendarYearID" ], "type": "object", "properties": { "jmlCreatedBy": { "type": "string" }, "jmlCreatedDate": { "type": "string", "format": "date-time" }, "jmlUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmlPlantID": { "type": "string" }, "jmlProductionCalendarYearID": { "type": "integer", "format": "int32" }, "jmlRowVersion": { "type": "integer", "format": "int64" }, "jmlWorkCenterID": { "type": "string" } } }, "ERPProductionCalendarWorkCenterDto": { "required": [ "jmrProductionCalendarLineID", "jmrProductionCalendarYearID", "jmrWorkCenterID" ], "type": "object", "properties": { "jmrCreatedBy": { "type": "string" }, "jmrCreatedDate": { "type": "string", "format": "date-time" }, "jmrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "jmrProductionCalendarLineID": { "type": "integer", "format": "int32" }, "jmrProductionCalendarYearID": { "type": "integer", "format": "int32" }, "jmrRowVersion": { "type": "integer", "format": "int64" }, "jmrWorkCenterID": { "type": "string" } } }, "ERPToolCategoryDto": { "required": [ "xtcToolCategoryID", "xtcDescription" ], "type": "object", "properties": { "xtcToolCategoryID": { "type": "string" }, "xtcCreatedBy": { "type": "string" }, "xtcCreatedDate": { "type": "string", "format": "date-time" }, "xtcDescription": { "type": "string" }, "xtcUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "xtcInactiveDate": { "type": "string", "format": "date-time" }, "xtcInactive": { "type": "boolean" }, "xtcRowVersion": { "type": "integer", "format": "int64" } } }, "ERPRMAActionTypeDto": { "required": [ "ratRmaActionTypeID", "ratDescription" ], "type": "object", "properties": { "ratRmaActionTypeID": { "type": "string" }, "ratDescription": { "type": "string" }, "ratUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "ratRowVersion": { "type": "integer", "format": "int64" } } }, "ERPScheduleAllocationDto": { "required": [ "sxdScheduleAllocationID" ], "type": "object", "properties": { "sxdDateType": { "type": "integer", "format": "int32" }, "sxdEndActualDateTime": { "type": "string", "format": "date-time" }, "sxdEndDate": { "type": "string", "format": "date-time" }, "sxdEndMinute": { "type": "integer", "format": "int32" }, "sxdUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxdGroupUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxdMinutes": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxdResourceUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxdRowVersion": { "type": "integer", "format": "int64" }, "sxdScheduleBranchID": { "type": "integer", "format": "int32" }, "sxdScheduleResourceLaneID": { "type": "integer", "format": "int32" }, "sxdScheduleTaskID": { "type": "integer", "format": "int32" }, "sxdScheduleTreeID": { "type": "integer", "format": "int32" }, "sxdScheduleAllocationID": { "type": "integer", "format": "int32" }, "sxdStartActualDateTime": { "type": "string", "format": "date-time" }, "sxdStartDate": { "type": "string", "format": "date-time" }, "sxdStartMinute": { "type": "integer", "format": "int32" } } }, "ERPScheduleBranchDto": { "required": [ "sxbScheduleTreeID", "sxbScheduleBranchID" ], "type": "object", "properties": { "sxbCreatedBy": { "type": "string" }, "sxbCreatedDate": { "type": "string", "format": "date-time" }, "sxbCurrentLinkedTaskDateType": { "type": "integer", "format": "int32" }, "sxbCurrentLinkedTaskID": { "type": "integer", "format": "int32" }, "sxbUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxbOffsetMinutes": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxbParentLinkedTaskDateType": { "type": "integer", "format": "int32" }, "sxbParentLinkedTaskID": { "type": "integer", "format": "int32" }, "sxbParentScheduleBranchID": { "type": "integer", "format": "int32" }, "sxbRowVersion": { "type": "integer", "format": "int64" }, "sxbScheduleTreeID": { "type": "integer", "format": "int32" }, "sxbScheduleBranchID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxbSiblingBranchLink": { "type": "integer", "format": "int32" } } }, "ERPScheduleResourceLaneDto": { "required": [ "sxrScheduleBranchID", "sxrScheduleTaskID", "sxrScheduleTreeID", "sxrScheduleResourceLaneID" ], "type": "object", "properties": { "sxrUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxrGroupUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxrLockedResourceUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxrResourceType": { "type": "integer", "format": "int32" }, "sxrRowVersion": { "type": "integer", "format": "int64" }, "sxrScheduleBranchID": { "type": "integer", "format": "int32" }, "sxrScheduleTaskID": { "type": "integer", "format": "int32" }, "sxrScheduleTreeID": { "type": "integer", "format": "int32" }, "sxrScheduleResourceLaneID": { "type": "integer", "format": "int32" } } }, "ERPScheduleTaskBucketDto": { "required": [ "sxeScheduleBranchID", "sxeScheduleTaskID", "sxeScheduleTreeID", "sxeScheduleTaskBucketID" ], "type": "object", "properties": { "sxeCompletedMinutes": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxeUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxeCompleted": { "type": "boolean" }, "sxeMinutes": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxePercentComplete": { "minimum": 0, "type": "integer", "format": "int32" }, "sxeRowVersion": { "type": "integer", "format": "int64" }, "sxeScheduleBranchID": { "type": "integer", "format": "int32" }, "sxeScheduleTaskID": { "type": "integer", "format": "int32" }, "sxeScheduleTreeID": { "type": "integer", "format": "int32" }, "sxeScheduleTypeBucketID": { "type": "integer", "format": "int32" }, "sxeScheduleTypeID": { "type": "integer", "format": "int32" }, "sxeScheduleTaskBucketID": { "type": "integer", "format": "int32" } } }, "ERPScheduleTaskDto": { "required": [ "sxkProcessID", "sxkScheduleBranchID", "sxkScheduleTreeID", "sxkScheduleTypeID", "sxkScheduleTaskID" ], "type": "object", "properties": { "sxkCreatedBy": { "type": "string" }, "sxkCreatedDate": { "type": "string", "format": "date-time" }, "sxkCurrentTaskDateType": { "type": "integer", "format": "int32" }, "sxkEndActualDateTime": { "type": "string", "format": "date-time" }, "sxkEndDate": { "type": "string", "format": "date-time" }, "sxkEndMinute": { "type": "integer", "format": "int32" }, "sxkUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxkExchangeID": { "type": "string" }, "sxkLinkedTaskDateType": { "type": "integer", "format": "int32" }, "sxkLinkedTaskID": { "type": "integer", "format": "int32" }, "sxkMinutes": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxkOffsetMinutes": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxkPlantDepartmentID": { "type": "string" }, "sxkPlantID": { "type": "string" }, "sxkProcessID": { "type": "string" }, "sxkRowVersion": { "type": "integer", "format": "int64" }, "sxkScheduleBranchID": { "type": "integer", "format": "int32" }, "sxkScheduleTreeID": { "type": "integer", "format": "int32" }, "sxkScheduleTypeID": { "type": "integer", "format": "int32" }, "sxkScheduleTaskID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxkStartActualDateTime": { "type": "string", "format": "date-time" }, "sxkStartDate": { "type": "string", "format": "date-time" }, "sxkStartMinute": { "type": "integer", "format": "int32" } } }, "ERPScheduleTreeDto": { "required": [ "sxtScheduleTreeID" ], "type": "object", "properties": { "sxtCreatedBy": { "type": "string" }, "sxtCreatedDate": { "type": "string", "format": "date-time" }, "sxtDescription": { "type": "string" }, "sxtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxtGroupUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxtJobScenarioID": { "type": "string" }, "sxtRowVersion": { "type": "integer", "format": "int64" }, "sxtScheduleTreeID": { "maximum": 9999, "minimum": 0, "type": "integer", "format": "int32" }, "sxtSourceTable": { "type": "string" }, "sxtSourceUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "sxtType": { "type": "integer", "format": "int32" } } }, "ERPDDFieldDto": { "type": "object", "properties": { "dfv3fd": { "type": "string" }, "dfTable": { "type": "string" }, "dfCalculationExpression": { "type": "string" }, "dfValueList": { "type": "string" }, "dfCaption": { "type": "string" }, "dfCaptionExpression": { "type": "string" }, "dfCaptionExpressionUser": { "type": "string" }, "dfSaveAsExpression": { "type": "string" }, "dfSaveAsExpressionUser": { "type": "string" }, "dfDBType": { "type": "string" }, "dfUDPr": { "type": "integer", "format": "int32" }, "dfReadonlyExpression": { "type": "string" }, "dfReadonlyExpressionUser": { "type": "string" }, "dfDecimals": { "type": "integer", "format": "int32" }, "dfDefaultExpression": { "type": "string" }, "dfDefaultExpressionUser": { "type": "string" }, "dfRelatedFields": { "type": "string" }, "dfRelatedTable": { "type": "string" }, "dfRelatedTableDescriptionField": { "type": "string" }, "dfRelatedTableFilter": { "type": "string" }, "dfRelatedTableOrderByField": { "type": "string" }, "dfRelatedTableReturnField": { "type": "string" }, "dfRelatedTableSearchGridId": { "type": "string" }, "dfRelationType": { "type": "integer", "format": "int32" }, "dfHelp": { "type": "string" }, "dfLength": { "type": "integer", "format": "int32" }, "dfSequence": { "type": "integer", "format": "int32" }, "dfSequenceUser": { "type": "integer", "format": "int32" }, "dfRequiredExpression": { "type": "string" }, "dfRequiredExpressionUser": { "type": "string" }, "dfFFil": { "type": "string" }, "dfVFld": { "type": "string" }, "dfField": { "type": "string" }, "dfHasChangeCode": { "type": "boolean" }, "dfRequiredForeignRelation": { "type": "boolean" }, "dfShowAsDropdown": { "type": "boolean" }, "dfShowAsDropdownUser": { "type": "boolean" }, "dfVisibleExpression": { "type": "string" }, "dfVisibleExpressionUser": { "type": "string" }, "dfHide": { "type": "boolean" }, "dfAllowNulls": { "type": "boolean" }, "dfIndexed": { "type": "boolean" }, "dfLower": { "type": "boolean" }, "dfDisplayName": { "type": "string" }, "dfDPrv": { "type": "boolean" }, "dfCurrencyUpdateRelatedField": { "type": "boolean" }, "dfCustom": { "type": "boolean" }, "dfCustomCaption": { "type": "boolean" }, "dfOLRelFld": { "type": "string" }, "dfOLType": { "type": "string" }, "dfUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dfModule": { "type": "string" }, "dfComments": { "type": "string" }, "dfConv": { "type": "string" }, "dfForeignKeyRequiredExpression": { "type": "string" }, "dfForeignKeyRequiredExpressionUser": { "type": "string" }, "dfFormat": { "type": "string" }, "dfBoundParentField": { "type": "string" }, "dfBoundParentFieldExpression": { "type": "string" }, "dfBoundParentFieldProxy": { "type": "string" }, "dfBoundParentFieldType": { "type": "integer", "format": "int32" }, "dfAppExtensionID": { "type": "string" }, "dfGroup": { "type": "string" }, "dfGroupParameters": { "type": "string" }, "dfStatus": { "type": "string" }, "dfCurrencyRelatedField": { "type": "string" }, "dfCurrencyType": { "type": "integer", "format": "int32" } } }, "ERPDDTableDto": { "type": "object", "properties": { "dtV3Tb": { "type": "string" }, "dtTable": { "type": "string" }, "dtUAddFld1": { "type": "string" }, "dtUAddFld2": { "type": "string" }, "dtUAddFld3": { "type": "string" }, "dtCaption": { "type": "string" }, "dtParentTable": { "type": "string" }, "dtAddFld1": { "type": "string" }, "dtAddFld2": { "type": "string" }, "dtAddFld3": { "type": "string" }, "dtReadonlyExpression": { "type": "string" }, "dtReadonlyExpressionUser": { "type": "string" }, "dtWebSeq": { "type": "integer", "format": "int32" }, "dtDefaultObjectId": { "type": "string" }, "dtMemoDescription": { "type": "string" }, "dtMemoDescriptionUser": { "type": "string" }, "dtKeyFields": { "type": "string" }, "dtKeyGroup": { "type": "string" }, "dtKeysAtThisLevel": { "type": "integer", "format": "int32" }, "dtChangeDetailIdsFilter": { "type": "string" }, "dtFieldToCheckOnUpdate": { "type": "string" }, "dtViewDef": { "type": "string" }, "dtViewSeq": { "type": "integer", "format": "int32" }, "dtDisableAddNewExpression": { "type": "string" }, "dtDisableAddNewExpressionUser": { "type": "string" }, "dtDisableChangeIDExpression": { "type": "string" }, "dtDisableChangeIDExpressionUser": { "type": "string" }, "dtDisableDeleteExpression": { "type": "string" }, "dtDisableDeleteExpressionUser": { "type": "string" }, "dtMailMerge": { "type": "boolean" }, "dtMap": { "type": "boolean" }, "dtHasDeleteCode": { "type": "boolean" }, "dtLastKeyCanBeEmpty": { "type": "boolean" }, "dtSaveAs": { "type": "boolean" }, "dtChangeID": { "type": "boolean" }, "dtShowMemos": { "type": "boolean" }, "dtShowMemosUser": { "type": "boolean" }, "dtImport": { "type": "boolean" }, "dtEmptyKeyCanBeEdited": { "type": "boolean" }, "dtDisplayName": { "type": "string" }, "dtSQLView": { "type": "boolean" }, "dtGridEdit": { "type": "boolean" }, "dtCustom": { "type": "boolean" }, "dtAutoIncrement": { "type": "boolean" }, "dtClosedCutoffDateField": { "type": "string" }, "dtClosedDateField": { "type": "string" }, "dtClosedExtraSetExpression": { "type": "string" }, "dtClosedField": { "type": "string" }, "dtClosedHelpLink": { "type": "string" }, "dtClosedIncludeOptionSqlExpr": { "type": "string" }, "dtClosedIncludeOptionText": { "type": "string" }, "dtClosedRoleCheck": { "type": "string" }, "dtClosedValue": { "type": "string" }, "dtIncrementAmount": { "type": "integer", "format": "int32" }, "dtIncrementAmountUser": { "type": "integer", "format": "int32" }, "dtUniqueField": { "type": "string" }, "dtUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "dtInitialValue": { "type": "string" }, "dtEnterInSequenceField": { "type": "string" }, "dtDocumentDateField": { "type": "string" }, "dtDocumentPlantIdField": { "type": "string" }, "dtModule": { "type": "string" }, "dtColorExpression": { "type": "string" }, "dtColorExpressionUser": { "type": "string" }, "dtContactField": { "type": "string" }, "dtForeignKeyDeleteFilter": { "type": "string" }, "dtAppExtensionID": { "type": "string" }, "dtPrefix": { "type": "string" }, "dtPrefixUser": { "type": "string" }, "dtVRel": { "type": "string" }, "dtGridID": { "type": "string" }, "dtPromptOnAddField": { "type": "string" }, "dtVTbl": { "type": "string" }, "dtUTbl": { "type": "string" }, "dtQuickSearchFields": { "type": "string" }, "dtQuickSearchFieldsUser": { "type": "string" }, "dtQuickSearchOption": { "type": "integer", "format": "int32" }, "dtNumericOnly": { "type": "integer", "format": "int32" }, "dtPurgeCutoffDateField": { "type": "string" }, "dtPurgeHelpLink": { "type": "string" }, "dtCurrencyCustomRateField": { "type": "string" }, "dtCurrencyExchangeRateField": { "type": "string" }, "dtCurrencyModeLocationField": { "type": "string" }, "dtCurrencyRateIdField": { "type": "string" }, "dtCurrencyUpdateType": { "type": "integer", "format": "int32" }, "dtAutoIncrementUser": { "type": "integer", "format": "int32" }, "dtOverrideDelete": { "type": "string" }, "dtOverrideDeleteEnabledExpression": { "type": "string" } } }, "ERPIntegrationTransactionQueueDto": { "required": [ "itqStatus" ], "type": "object", "properties": { "itqApIAction": { "type": "string" }, "itqCreatedBy": { "type": "string" }, "itqCreatedDate": { "type": "string", "format": "date-time" }, "itqEntityType": { "type": "string" }, "itqUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "itqErrorCode": { "type": "string" }, "itqErrorMessage": { "type": "string" }, "itqIntegrationType": { "type": "string" }, "itqNextRetryTime": { "type": "string", "format": "date-time" }, "itqParentUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "itqRequest": { "type": "string" }, "itqResponse": { "type": "string" }, "itqRetryCount": { "type": "integer", "format": "int32" }, "itqSourceTableName": { "type": "string" }, "itqSourceTableUniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "itqStatus": { "type": "string" }, "itqStatusUpdatedDate": { "type": "string", "format": "date-time" }, "itqTransactionType": { "type": "string" } } }, "CTMAPSJobOperationDto": { "required": [ "jobID", "jobAssemblyID", "jobOperationID", "operationType", "workCenterID", "processID", "processShortDescription", "standardFactor", "machineType", "quantityPerAssembly", "operationQuantity" ], "type": "object", "properties": { "jobID": { "type": "string" }, "jobAssemblyID": { "type": "integer", "format": "int32" }, "jobOperationID": { "type": "integer", "format": "int32" }, "operationType": { "type": "integer", "format": "int32" }, "workCenterID": { "type": "string" }, "processID": { "type": "string" }, "processShortDescription": { "type": "string" }, "productionStandard": { "type": "number", "format": "double" }, "standardFactor": { "type": "string" }, "machinesToSchedule": { "type": "integer", "format": "int32" }, "machineType": { "type": "integer", "format": "int32" }, "quantityPerAssembly": { "type": "number", "format": "double" }, "quantityComplete": { "type": "number", "format": "double" }, "operationQuantity": { "type": "number", "format": "double" }, "setupRate": { "type": "number", "format": "double" }, "productionRate": { "type": "number", "format": "double" }, "overheadRate": { "type": "number", "format": "double" }, "partID": { "type": "string" }, "partRevisionID": { "type": "string" }, "partWarehouseLocationID": { "type": "string" }, "partBinID": { "type": "string" }, "unitOfMeasure": { "type": "string" }, "plantID": { "type": "string" }, "closed": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time" }, "setupHours": { "type": "number", "format": "double" }, "actualSetupHours": { "type": "number", "format": "double" }, "actualproductionhours": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "uniqueID": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "setupcomplete": { "type": "boolean" }, "purchaseorderID": { "type": "string" }, "purchaselocationID": { "type": "string" }, "supplierorganizationID": { "type": "string" }, "rfqID": { "type": "string" }, "processLongDescriptionText": { "type": "string" }, "processLongDescriptionRTF": { "type": "string" }, "estimatedProductionHours": { "type": "number", "format": "double" }, "estimatedUnitCost": { "type": "number", "format": "double" } } }, "CTMBOMPartRevisionGuidDto": { "type": "object", "properties": { "revisionId": { "type": "string" }, "revisionGuid": { "type": "string" }, "partAssemblyGuids": { "type": "array", "items": { "$ref": "#/components/schemas/CTMBOMPartAssemblyGuidDto" } } } }, "CTMBOMPartAssemblyGuidDto": { "type": "object", "properties": { "assemblyId": { "type": "integer", "format": "int32" }, "assemblyGuid": { "type": "string" }, "partMaterialGuids": { "type": "array", "items": { "$ref": "#/components/schemas/CTMBOMPartMaterialGuidDto" } }, "partOperationGuids": { "type": "array", "items": { "$ref": "#/components/schemas/CTMBOMPartOperationGuidDto" } } } }, "CTMBOMPartMaterialGuidDto": { "type": "object", "properties": { "materialId": { "type": "integer", "format": "int32" }, "materialGuid": { "type": "string" } } }, "CTMBOMPartOperationGuidDto": { "type": "object", "properties": { "operationId": { "type": "integer", "format": "int32" }, "operationGuid": { "type": "string" } } } }, "securitySchemes": { "oauth2": { "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": [ { "oauth2": [ ] } ] }